How to I add Property descriptions to Class Properties?

[Chad]

when I create a class, I would like to add a Description to each of the propeties so it appears in the object browser.

I would have thought that it would be similar to the way you do it it Custom Controls (not very familiar in this area):

<Bindable(True), Category("Appearance"), Description("My Description"), DefaultValue("")> Property [Text]() As String

I tried adding thuis tag right before my property declaration, but the compiler didn't seem to take it:

<Description("My Description")>

Suggestions?

Thanks,

Chad

[Ken Tucker [MVP]]

Hi,

You need to use xml documentation for that.

From Herfrieds Faq.

VB Commenter
<http://www.gotdotnet.com/team/ide/>
-> section "VB Commenter"

XML Documentation
<http://www.gotdotnet.com/team/vb/>
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
<http://vbxmldoc.tor-erik.net/index.shtml>

NDOC (formerly DOC.NET)
<http://ndoc.sourceforge.net/>

VB.DOC
<http://vb-doc.sourceforge.net/>

<http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd>
Ken
--------------
"Chad" <ch**************@unisys.com> wrote in message
news:cv**********@trsvr.tr.unisys.com...
when I create a class, I would like to add a Description to each of the
propeties so it appears in the object browser.

I would have thought that it would be similar to the way you do it it Custom
Controls (not very familiar in this area):
<Bindable(True), Category("Appearance"), Description("My Description"),
DefaultValue("")> Property [Text]() As String

I tried adding thuis tag right before my property declaration, but the
compiler didn't seem to take it:
<Description("My Description")>

Suggestions?
Thanks,
Chad

[Herfried K. Wagner [MVP]]

Hi Ken,

"Ken Tucker [MVP]" <vb***@bellsouth.net> schrieb:

You need to use xml documentation for that.

From Herfrieds Faq.

.... and the complete FAQ can be found here:

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

:-)

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://dotnet.mvps.org/dotnet/faqs/>