属性/访问器的 XML 注释答案

【问题标题】：XML comments for properties / accessors属性/访问器的 XML 注释
【发布时间】：2012-05-27 00:59:22
【问题描述】：

是否可以为set 和get 访问器添加XML cmets，它们将在对象浏览器（VS 2010）中可见？

/// <summary>
/// Something about property.
/// </summary>

public bool IsSomething
{
    // get description

    get
    {
        return isSomething;
    }

    // set description

    set
    {
        // do some work
    }
}

【问题讨论】：

如果你真的想为get和set单独添加cmets，你总是可以自己实现getter和setter方法，然后把你的XML cmets放在getter和setter方法上。
如果可以的话，大多数时候这将毫无意义。属性不应该负责复杂的逻辑。如果您想应用一些复杂的逻辑，请忘记属性并编写一个方法并添加您的 cmets。由于您不想在属性中执行大量逻辑，因此无需对其进行评论。
我将属性用于使用很少 cpu 资源的逻辑。对于复杂的逻辑（更多的 cpu 使用）我使用方法。但我只是问......一些属性可以有逻辑，如约束将值设置为 0..100 字节等。

标签： c# .net xml-comments

【解决方案1】：

不，您不能直接在访问器上设置这些 cmets。但是，该属性上的 cmets 可能非常全面，当您开始键入它们时，您将获得 IntelliSense 建议。如果你有扩展的 cmets，你可能想把额外的东西放在评论的备注部分：

/// <summary>
///   Something about the property.
/// </summary>
/// <remarks>
/// Some extra remarks that won't show up in the property's IntelliSense later.
/// </remarks>

【讨论】：

【解决方案2】：

不这么认为，至少不在那个位置。我只想在其他现有标签中添加信息，如下所示：

/// <summary>
/// Gets or sets the x.
/// </summary>
/// <value>
/// The x.
/// </value>
/// <returns> this saves the world</returns>
/// <remarks> when you set this the world ends</remarks>

【讨论】：