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以便于评论

如何评论公开可见类型的枚举？

2 个答案: