Typing your own Function help

[ThePentiumGuy]

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

[mutant]

It is called XML Documentation. VB.NET IDE currently doesn't 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.

[ThePentiumGuy]

Ah man...:(. Wish VB.NET supported it as well. Oh well, it's no big deal - descriptive function arguments will do.

 

Thanks,

-The Pentium Guy

[ThePentiumGuy]

Actually, a quick Google search worked :).

 

www.gotdotnet.com/team/vb/

and

www.fesersoft.com/products/vbxmlcomments/default.asp

:). Thanks for telling me bout what it was called.

[Denaes]

Don't quote me 100% on this, but I heard the vb2005 has native XML Help