Как я комментирую публично видимое Перечисление типа?

Question

Как я комментирую публично видимое Перечисление типа?

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

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

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

38

c# enums comments

задан Eric 22 July 2010 в 14:45

2 ответа

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

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

Вы также можете проверить GhostDoc , чтобы легко комментировать

14

ответ дан 27 November 2019 в 03:09

Другие вопросы по тегам:

c# enums comments

Похожие вопросы:

score 97 · Accepted Answer

Вот так:

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

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

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

Кстати. ваш enum на самом деле должен называться ComparisonType.