Come si commenta un tipo Enum pubblicamente visibile?

Question

Come commento questo Enum in modo che l'avviso non venga visualizzato? Sì, mi rendo conto che i commenti non sono necessari, ma se commentare è semplice e risolve gli avvertimenti, mi piacerebbe farlo.

Avvertimenti che appaiono: mancante commento XML per il tipo pubblicamente visibili o membro

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

Answer 1

Ti piace questa:

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

(Sì, questo può diventare molto noioso)

Si può voglio usare testi diversi nei commenti.

A proposito. il tuo enum dovrebbe essere chiamato in realtà ComparisonType.

Answer 2

Commento ogni membro:

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

Si consiglia inoltre di controllare GhostDoc per una facile commentare