XML comments for properties / accessors

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

If you'd really like to add comments for get and set independently, you could always implement the getter and setter methods yourself, then put your XML comments on the getter and setter methods. — Isaac Overacker
– Isaac Overacker, Commented May 27, 2012 at 1:25
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. — Mert Akcakaya
– Mert Akcakaya, Commented May 27, 2012 at 1:38
I use properties for logic which use very few cpu resources. For complex logic (more cpu usage) I use methods. But I just ask... some properties can have logic like constraints set value to 0..100 for byte etc. — apocalypse
– apocalypse, Commented May 27, 2012 at 2:12

Pang · Accepted Answer · 2021-01-06 00:43:00Z

10

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>

edited Jan 6, 2021 at 0:43

Pang

10.2k146 gold badges87 silver badges126 bronze badges

answered May 27, 2012 at 1:25

slugster

50k14 gold badges105 silver badges150 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Pang · Accepted Answer · 2020-10-06 09:06:03Z

3

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>

edited Oct 6, 2020 at 9:06

Pang

10.2k146 gold badges87 silver badges126 bronze badges

answered May 27, 2012 at 1:23

madmik3

6,9933 gold badges40 silver badges62 bronze badges

Collectives™ on Stack Overflow

XML comments for properties / accessors

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related