XML注释用于属性/访问器

9

是否可以为setget访问器添加XML注释,以便在Object Browser (VS 2010)中可见?

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

public bool IsSomething
{
    // get description

    get
    {
        return isSomething;
    }

    // set description

    set
    {
        // do some work
    }
}

如果您真的想为get和set分别添加注释,您可以自己实现getter和setter方法,然后在getter和setter方法上放置XML注释。 - Isaac Overacker
1
大多数情况下,如果可以的话,这将是毫无意义的。属性不应该负责复杂的逻辑。如果您想应用一些复杂的逻辑,请忘记属性并编写一个方法并添加您的注释。由于您不希望在属性内执行大量逻辑,因此您不需要对它们进行注释。 - Mert Akcakaya
我使用属性来处理逻辑,这些属性使用非常少的CPU资源。对于复杂的逻辑(更多的CPU使用),我使用方法。但是我只是想问一下...有些属性可以具有像约束设置值为0..100的逻辑,例如byte等。 - apocalypse
2个回答

10

不,您不能直接在访问器上设置这些注释。然而,属性上的注释可以非常详细,当您开始输入它们时,您将获得IntelliSense建议。如果您有扩展注释,您可能希望将额外的内容放在注释的备注部分:

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

3

不太可能,在那个位置上至少不是这样。我会把信息添加到其他已存在的标签内,像这样:

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

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接