2010-07-22 23 views
26

Comment commenter cette énumération afin que l'avertissement n'apparaisse pas? Oui je réalise que les commentaires sont inutiles, mais si commenter est facile et résout les avertissements alors je voudrais le faire.Comment commenter un type Enum visible publiquement?

avertissements qui apparaissent: commentaire XML manquant pour le type public visible ou membre

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

Répondre

73

Comme ceci:

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

(Oui, cela peut être très fastidieux)

Vous pouvez vouloir utiliser des textes différents dans les commentaires. Par ailleurs, en passant,

votre énumération devrait être appelée ComparisonType.

+1

upvoted pour le ComparisonType, ce qui est vraiment important! – Lucas

10

Commentaire chaque membre:

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

Vous pouvez également consulter GhostDoc pour faciliter des commentaires