Typing your own Function help

ThePentiumGuy

Well-known member
Joined
May 21, 2003
Messages
1,113
Location
Boston, Massachusetts
Hey,

.NET helps you out by providing tooltips for each argument when you type in a Function. For example when you type in MessageBox.Show(
it will tell you that the first argument is a string, but it will also tell you that this argument is "The text to display in the MessageBox" <-- this is what i want to do.

How do you write your own help for your functions? Is it simple ;)?

-The Pentium Guy
 
It is called XML Documentation. VB.NET IDE currently doesnt support it, but C# does. Just place the caret over a method, property etc. and type in three slashes and the IDE will generate required tags. Also, in your project properties you have to set a name for the documentation file and property which specifies whether to create the doc file.
 
Back
Top