Object Browser Descriptions

[Mike Labosh]

If I click on an item in the Object Browser, the description pane displays a
brief help-text for the item. I'm certain that I can add this useful
description to my class members by applying some attribute to my property or
method, but I'm not sure what Attribute class I should be looking for.

Anyone have a hint?

--
Peace & happy computing,

Mike Labosh, MCSD

"Mr. McKittrick, after very careful consideration, I have
come to the conclusion that this new system SUCKS!"
~~ General Barringer ~~

 

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

If I click on an item in the Object Browser, the description pane displays a
brief help-text for the item. I'm certain that I can add this useful
description to my class members by applying some attribute to my property or
method, but I'm not sure what Attribute class I should be looking for.

Anyone have a hint?

--
Peace & happy computing,

Mike Labosh, MCSD

"Mr. McKittrick, after very careful consideration, I have
come to the conclusion that this new system SUCKS!"
~~ General Barringer ~~

 

[Herfried K. Wagner [MVP]]

If I click on an item in the Object Browser, the description pane displays
a
brief help-text for the item. I'm certain that I can add this useful
description to my class members by applying some attribute to my property
or
method, but I'm not sure what Attribute class I should be looking for.

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

 

[Mike Labosh]

Thanks!

--
Peace & happy computing,

Mike Labosh, MCSD

"Mr. McKittrick, after very careful consideration, I have
come to the conclusion that this new system SUCKS!"
~~ General Barringer ~~