Function Desc

  • Thread starter Thread starter Tibby
  • Start date Start date
T

Tibby

Okay, here's a crazy one, how does one add descriptions to custom made functions?

--
Thanks
 
* "Tibby said:
Okay, here's a crazy one, how does one add descriptions to custom made functions?
Click to expand...

For VB.NET 2002/2003:

My XML Comments 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>

VB.NET 2004 (Whidbey) will include XML documentation.
 
Wow, that's alot of info. Not sure on which one I'm looking for.
Basically, I'm looking to provide the same functionality as when you type in
:
System.Array.Reverse and it gives a discription of things.
I'm thinking it's the second link you provided, and I'm going to run with
that for the moment.

Thanks again Herfried.
Tibby
 
I would like to mimick the behavour that happens when you type in
System.Array.Reverse(
It comes up and tells you what the function does, and what each argument
of the function is for. There must be a way of doing it, and if I have to
learn the process, write a small app, and go from there, no prob.
Alas, I haven't found anything that's simple. I still want to be able
to add my own comments to code I've created, and the best canidate, VBXC,
does not work as it has claimed, but it's free, so can't complain.
There has to be a way to do this if MS has done it with Framework
functions, and there's programs to do it.

Thanks again
Tibby
 
* "Tibby said:
I would like to mimick the behavour that happens when you type in
System.Array.Reverse(
It comes up and tells you what the function does, and what each argument
of the function is for. There must be a way of doing it, and if I have to
learn the process, write a small app, and go from there, no prob.
Alas, I haven't found anything that's simple. I still want to be able
to add my own comments to code I've created, and the best canidate, VBXC,
does not work as it has claimed, but it's free, so can't complain.
There has to be a way to do this if MS has done it with Framework
functions, and there's programs to do it.
Click to expand...

The Framework is mostly implemented in C#, and the C# compiler supports
XML comments directly. The VB.NET compiler doesn't at the moment. You
will have to use one of the 3rd party tools mentioned before to create
the XML file from your VB.NET code comments.
 
Back
Top