Adding method descriptions

[Max]

Searched all over google and can't seem to find how to do this. How do I
go about adding comments about my own functions and sub-procedures? Like
when I use them, the tool-tip tells me more then just how it was declared?

[Herfried K. Wagner [MVP]]

* Max <ma*****@yahoo. com> scripsit:

Searched all over google and can't seem to find how to do this. How do
I go about adding comments about my own functions and sub-procedures?
Like when I use them, the tool-tip tells me more then just how it was
declared?

My FAQ:

Adding tooltips in intellisense for VB.NET assemblies:

VS.NET takes the text shown in intellisense tips from an XML file that
is provided in addition to the assembly (for example, a DLL). The XML
file must have the same name as the corresponding DLL with ".xml"
appended and must be placed in the same folder as the assembly
(assembly "Foo.dll", XML file "Foo.dll.xm l").

The format of the XML file taken by VS.NET is specified here:

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

For C#, VS.NET creates this XML file automatically (compiler option
"/doc"). For VB.NET, that's currently not supported, but this will be
possible in VB 2005.

You can create the XML file by hand, but notice that this will take a
lot of time and it will be hard to update the file if parts of the
assembly change. It's much easier to use one of the tools listed below
to create the XML file. Tools like NDOC will take the XML file and can
be used to create an HTML Help file from this data.

One easy way is to provide information for tooltips as XML comments
inside the source files and then use tools like VB.DOC to create the XML
file that contains the data. Then you can copy this file into the
assembly's directory to provide information to VS.NET that enables it to
display tooltips, or you can create a help file. The help file can be
deployed with the assembly and can be used by other developers who use
the assembly as reference.

For VB.NET 2002/2003:

My XML Comments FAQ:

VB Commenter
<URL:http://www.gotdotnet.c om/team/ide/>
-> "VB Commenter"

XML Documentation
<URL:http://www.gotdotnet.c om/team/vb/>
-> "XML Documentation"

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

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

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

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

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

C# XML comments:

C# Programmer's Reference -- Recommended Tags for Documentation Comments
<URL:http://msdn.microsoft. com/library/en-us/csref/html/vclrfTagsForDoc umentationComme nts.asp>

--
Herfried K. Wagner [MVP]
<URL:http://dotnet.mvps.org/>