web-dev-qa-db-ja.com

公開されている型Enumにコメントするにはどうすればよいですか?

警告が表示されないように、この列挙型にコメントするにはどうすればよいですか?はい、コメントは不要だと思いますが、コメントが簡単で、警告が解消されればやりたいです。

表示される警告:公開されているタイプまたはメンバーのXMLコメントがありません

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

このような:

/// <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と呼ばれるべきです。

102
SLaks

各メンバーにコメント:

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

簡単にコメントできるように、 GhostDoc をチェックアウトすることもできます。

16