Comment commenter un Enum de type visible publiquement?

Question

Comment commenter cette énumération pour que l'avertissement n'apparaisse pas? Oui, je me rends compte que les commentaires ne sont pas nécessaires, mais si les commentaires sont faciles et qu'ils résolvent les avertissements, j'aimerais le faire.

Avertissements qui s'affichent: commentaire XML manquant pour le type ou le membre visible publiquement

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

Answer 1

Comme ça:

/// <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 devenir très fastidieux)

Vous voudrez peut-être utiliser différents textes dans les commentaires.

Au fait. votre énumération devrait en fait être appelée ComparisonType.

Answer 2

Commentez 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 commenter facilement