Method's description

[Chris Wagner]

How do you put method description in a method (sub, property) so user can
see it when he browses a method? Thanks

 

[Eric Lemmon]

Hi Chris,

The Intellisence method descriptions come from an XML file corresponding to
the DLL you are using. (There are a ton of threads on this topic if you
want more specifics...just search the groups for "Intellisense
Description".)

There is a VB.NET XML Documentation Tool (found at
http://www.gotdotnet.com/team/vb/ ) that will help you out a bit.

If you are comfortable with C#, you might want to write your classes in C#
because it will save you a few steps. The C# compiler generates the XML
file automatically using whatever is in the /// <summary> tags within your
code.

Hope this helps!

Eric

 

[Chris Wagner]

Thanks very much. I just downloaded VBcommenter and it works great!

 

[Herfried K. Wagner [MVP]]

How do you put method description in a method (sub, property) so user can
see it when he browses a method? Thanks

You will have to provide an XML file with the DLL which has the name of
the DLL with ".xml" appended.

<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfProcessingXMLFile.asp>

For VB.NET 2002/2003:

My XML Comments FAQ:

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

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

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

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

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

<URL:http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd>

XML comments will be introduced to VB.NET in version 2005 ("Whidbey").

C# XML comments:

<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfTagsForDocumentationComments.asp>