XML comments for properties / accessors

apocalypse picture apocalypse · May 27, 2012 · Viewed 11.1k times · Source

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

Answer

slugster picture slugster · May 27, 2012

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>