XML comments for properties / accessors

11,419

Solution 1

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>

Solution 2

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>
Share:
11,419

Related videos on Youtube

apocalypse
Author by

apocalypse

:F

Updated on September 15, 2022

Comments

  • apocalypse
    apocalypse over 1 year

    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
        }
    }
    
    • Mert Akcakaya
      Mert Akcakaya almost 12 years
      It would be meaningless most of the time if you could. Properties should not be responsible for complex logic. If you want to apply some complex logic, forget about properties and write a method and add your comments. Since you don't want to do a lot of logic inside your properties you don't need to comment them.