Các chuẩn C# "định dạng" là gì?

Question

Trong C# (. NET), chuẩn "định dạng" thông thường là gì?

Ví dụ: đối với tên thông số, cho đến nay tôi nhận thấy camelCase không có tiền tố, đúng không? Đối với tên đối tượng, camelCase và không có tiền tố, phải không?

Đối với không gian tên, lớp, chức năng và thuộc tính, chữ cái đầu tiên của từ được viết hoa và không có tiền tố, phải không (lại)?

Đối tượng "tạm thời" được định dạng như thế nào?

Ví dụ:

namespace TestNamespace 
{ 
    class MyOwnCoolClass 
    { 
     MyOwnCoolClass(int length, BinaryWriter writer) 
     { 
      BinaryWriter tempbw = new BinaryWriter(length); 
      return tempbw; 
     } 
    } 
} 

(Lưu ý: Mã này là không hợp lệ, tôi biết, nó chỉ là để chứng minh định dạng). Cảm ơn!

Answer 1

Nếu bạn sử dụng StyleCop, bạn sẽ nhận được sự nhất quán tốt với Microsoft .NET Design Guidelines for Developing Class Libraries. StyleCop cũng thực thi một số điều bổ sung như khoảng cách, thứ tự các mục trong một tệp và đặt tên các phần tử mã không công khai.

Answer 2

Hướng dẫn đầy đủ từ Microsoft có thể được tìm thấy trong Class Design Guidelines. Đó là cũ, nhưng tôi chưa tìm thấy bất cứ điều gì cập nhật trên MSDN, và tôi tin rằng nó vẫn là tiêu chuẩn thiết lập đề nghị

Answer 3

tôi sẽ xem xét những điều sau Coding Practices.

Nó bao gồm hầu như tất cả mọi thứ mà tôi nhìn thấy trong hầu hết các mã C# mà tôi đọc ... bao gồm tiền tố yếu tố UI. Cá nhân tôi không tuân theo nó với lá thư nhưng nó cho bạn ý tưởng tốt về tiêu chuẩn chung và thực hành tốt/xấu.

Answer 4

Có tham chiếu đến các tiêu chuẩn mã hóa của Microsoft. Visual Studio 2005 và 2008 có một công cụ phân tích mã được xây dựng trong đó sẽ hướng dẫn bạn thông qua các tiêu chuẩn mã hóa và cũng chỉ cho bạn hướng tới một số thực hành tốt nhất. Nhấp chuột phải vào dự án của bạn và nhấp vào "Chạy phân tích mã trên dự án".

Bất cứ khi nào một phần mã không hợp lệ hoặc ít được ưu tiên được phát hiện, nó sẽ không chỉ cảnh báo bạn, mà chỉ cho bạn một Tài nguyên trợ giúp trên trang FxCop.

Answer 5

MSDN: Naming Guidelines

tôi có xu hướng đi theo cách .NET framework được mã hóa do đó, mã của tôi là phù hợp với .NET Framework.

Tùy chọn cá nhân duy nhất của tôi là đặt tên biến lớp mà tôi sử dụng tiền tố "m_" trước mỗi biến như private int m_count.

Answer 6

Bạn có thể sử dụng kết hợp StyleCop và FxCop (hoặc tích hợp Mã phân tích cho VS2008 Pro) cho các công cụ và Framework Design Guidelines.

Answer 7

Tôi đã viết these guidelines trong năm qua sử dụng các nguyên tắc khác nhau từ MSFT và các nguyên tắc được chấp nhận rộng rãi khác. Bạn có thể muốn kiểm tra xem nó ra, nó cũng có những thứ khác, như thiết lập dự án và không có điều gì, nhưng tất cả các hướng dẫn đặt tên cũng có trong đó.

chỉnh sửa: Tôi nhận thấy rằng đây là phiên bản cũ, tôi có phiên bản mới mà tôi đã viết trong một thời gian và nó chứa rất nhiều tính năng, nhưng chưa xong. Tôi sẽ cập nhật bài đăng này khi nó được xuất bản mặc dù.