Как прокомментировать общедоступный тип Enum?

Question

Как прокомментировать это перечисление, чтобы предупреждение не появилось? Да, я понимаю, что комментарии не нужны, но если комментирование легко и оно разрешает предупреждения, я бы хотел это сделать.

предупреждение, которые появляются: XML отсутствует комментарий для общедоступного типа или члена

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

Answer 1

Как это:

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

(Да, это может быть очень утомительно)

Вы можете хотите использовать разные тексты в комментариях.

Кстати. ваше перечисление должно называться ComparisonType.

Answer 2

Комментарий каждый член:

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

Вы также можете проверить GhostDoc для удобного комментирования