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

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

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

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

Ответы

Ответ 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.

Ответ 2

Прокомментировать каждого участника:

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

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