Jak mogę skomentować publicznie widoczny typ Enum?

Question

Jak mogę skomentować to wyliczenie, aby ostrzeżenie się nie pojawiło? Tak, zdaję sobie sprawę, że komentarze są niepotrzebne, ale jeśli komentowanie jest łatwe i rozwiązuje ostrzeżenia, to chciałbym to zrobić.

ostrzeżenia, które pojawiają się: Missing komentarz XML dla publicznie widoczne typu lub członka

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

Answer 1

tak:

/// <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 
} 

(Tak, to może być bardzo uciążliwe)

Użytkownik może chcesz używać różnych tekstów w komentarzach.

Przy okazji. Twoje wyliczenie powinno być nazywane ComparisonType.

Answer 2

Komentarz każdy członek:

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

Można też sprawdzić GhostDoc do łatwego komentowania