Question

Is it possible to add XML comments for set and get accessors which will be visible in Object Browser (VS 2010)?

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

public bool IsSomething
{
    // get description

    get
    {
        return isSomething;
    }

    // set description

    set
    {
        // do some work
    }
}
Was it helpful?

Solution

No, you cannot set these comments directly on the accessors. The comments on the property, however, can be quite comprehensive, you will get IntelliSense suggestions when you start to type them. If you have extended comments, you might want to put the extra stuff in the remarks section of the comment:

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

OTHER TIPS

Don't think so, at least not in that location. I would just add the info inside of other existing tags, like so:

/// <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>
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top