Help boxes with Properties

[Jerry Spence1]

How, when defining a property, do you add some help so the user can see what
the property does when using it? Tricky to describe what I mean but when you
create a class with properties and use it. As soon as you type the class
name followed by a dot, you get a list of properties. You then see a a
sentence offering an explanation as to what the property does.

Thanks

-Jerry

 

[Herfried K. Wagner [MVP]]

How, when defining a property, do you add some help so the user can see
what
the property does when using it? Tricky to describe what I mean but when
you
create a class with properties and use it. As soon as you type the class
name followed by a dot, you get a list of properties. You then see a a
sentence offering an explanation as to what the property does.

For property descriptions which are displayed in the property grid of the
IDE specify a 'Description' attribute on the properties. IntelliSense texts
can be added using XML comments:

Adding IntelliSense tooltips, XML comments, and documentation
<URL:http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en>

 

[Jerry Spence1]

For property descriptions which are displayed in the property grid of the
IDE specify a 'Description' attribute on the properties. IntelliSense
texts can be added using XML comments:

Adding IntelliSense tooltips, XML comments, and documentation
<URL:http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en>

Thanks Herfried. Much more complicated than I thought. I'll have a read
through.

-Jerry