2

我通常将类中的字段声明为私有字段以及从外部访问该字段的公共属性（到目前为止没有什么特别的微笑）：

private bool doILookGood;

public bool DoILookGood
{
   get { return doILookGood; }
   set { doILookGood = value; }
}

现在我想知道是否有一种优雅而有效的方式来评论这种情况，而无需两次写相同的评论。换句话说，我想保留 IDE 在鼠标悬停时使用工具提示向我显示变量注释的功能。

到目前为止，我是这样评论的：

/// <summary>
/// This i always true.
/// </summary>
private bool doILookGood;

/// <summary>
/// This i always true.
/// </summary>
public bool DoILookGood
{
   get { return doILookGood; }
   set { doILookGood = value; }
}

我想要这样的东西：

/// <summary>
/// This i always true.
/// </summary>
private bool doILookGood;

/// <summary cref="doILookGood" />
public bool DoILookGood
{
   get { return doILookGood; }
   set { doILookGood = value; }
}

我知道使用 XML 标记来评论私有字段并不是很有意义，因为它们不会出现在生成的文档中，但我又只想拥有（IDE 内部的）评论工具提示。

也许有人有线索:)

4

1 回答 1

6

尽可能使用自动属性。这将避免在不需要时使用私有成员。

public bool DoILookGood { get; set; }

如果不可能（例如在实现时INotifyPropertyChanged），这就是我的处理方式（请注意，这只是示例，我肯定会使用自动属性而不是下面的代码）：

    /// <summary>
    /// Private member for <see cref="MyValue"/>.
    /// </summary>
    private bool myValue;

    /// <summary>
    /// Gets or sets a value indicating whether ...
    /// </summary>
    /// <value>
    ///   <c>true</c> if ...; otherwise, <c>false</c>.
    /// </value>
    public bool MyValue
    {
        get { return this.myValue; }
        set { this.myValue = value; }
    }

编辑：我还建议使用GhostDoc来节省时间（一个能够自动生成评论的插件）。

于 2011-12-26T13:15:02.967 回答