Làm cách nào để nhận xét một loại hiển thị công khai Enum?

Question

Làm cách nào để nhận xét Enum này để cảnh báo không xuất hiện? Có, tôi nhận thấy rằng các nhận xét là không cần thiết, nhưng nếu nhận xét là dễ dàng và nó giải quyết các cảnh báo thì tôi muốn làm điều đó.

Cảnh báo xuất hiện: Thiếu bình luận XML cho loại hiển thị công khai hoặc thành viên

/// <summary> 
/// Conditional statements 
/// </summary> 
public enum ConditionType 
{ 
    Equal, 
    NotEqual, 
    GreaterThan, 
    GreaterThanOrEqual, 
    LessThan, 
    LessThanOrEqual 
} 

Answer 1

Như thế này:

/// <summary> 
/// Conditional statements 
/// </summary> 
public enum ConditionType 
{ 
    ///<summary>A == B</summary> 
    Equal, 
    ///<summary>A != B</summary> 
    NotEqual, 
    ///<summary>A > B</summary> 
    GreaterThan, 
    ///<summary>A >= B</summary> 
    GreaterThanOrEqual, 
    ///<summary>A < B</summary> 
    LessThan, 
    ///<summary>A <= B</summary> 
    LessThanOrEqual 
} 

(Vâng, điều này có thể nhận được rất tẻ nhạt)

Bạn có thể muốn sử dụng các văn bản khác nhau trong các ý kiến.

Nhân tiện. enum của bạn thực sự nên được gọi là ComparisonType.

Answer 2

Comment mỗi thành viên:

/// <summary> 
/// Conditional statements 
/// </summary> 
public enum ConditionType 
{ 
    /// <summary> 
    /// Tests for equality 
    /// </summary> 
    Equal, 
    /// <summary> 
    /// Tests for inequality 
    /// </summary> 
    NotEqual, 
    // etc.. 
} 

Bạn cũng có thể muốn kiểm tra GhostDoc để dễ dàng cho ý kiến ​​