Implementation of (internal) "interface documentation" for functions and parameters?

  • Thread starter Thread starter BoonHead, The Lost Philosopher
  • Start date Start date
B

BoonHead, The Lost Philosopher

Does anyone know how to implement internal interface documentation for
functions and parameters?

I found a similair thing for proerties.
For properties I found something like:
<System.ComponentModal.Description("This property sets aars!")> Property
Aars() As Boolean
'...Property body...
End Property

But there is not anything documented about descriptions (internal interface
documentation) for functions and parameters.
I tried the the following but ofcouse it didn't work:

<System.ComponentModal.Description("This function kicks aars!")> Function
KickAars(<System.ComponentModal.Description("Hey a parameter")> blnKick As
Boolean) As Boolean

Does anyone know how to create interface documentation in the same way
microsoft does?
I'll give you an example if you still don't know what I'm talking about:

Type some function like "Beep(" and you will see a tooltip explaining how to
use the function and information about it's parameters.
The same thing can be done with your own classes, properties, functions and
parameters...I just don't know how... :S
 
BoonHead said:
Does anyone know how to implement internal interface documentation for
functions and parameters?
Click to expand...

Yes - you use XML documentation. It's not available by default in the
current version of VB.NET, but it's coming in the next version and
there are already plug-ins to make it available now, eg
http://vb-doc.sourceforge.net/
 
I have no idea of how to implement this.
My first guess is to do something like this:

* Function Bla(intIndex As Index) 'Here goes my comment

* Import the project in VB-Doc
* VB-Doc outputs the .xml file
* I can add some more comments for intIndex and so...
* And at last I run:
vbc project.vbproj /doc
or something... (I guess I do a "vbc /?" first)

I was sniffing the net and msdn for a whole day.
Atleast I have "a new scent to follow"...
 
Yes, I have downloaded it.
Thanx van the URL.

I'm gonna read the documantary at home.
 
1) I've read how to implement the interface documentation in the source
code.

'<summary>....</summary>
'etc...
Function Bla(.......

As seen in the readme file of VB.DOC.

2) I am not using the plug-in because it does not seem to work.
I think that's because I have VS.NET 2002 instead of 2003.
No matter; the standalone will do just fine.

3) Question however: How do I compile the commentrie/interface documentation
into it's module?
(In other words: Source.vb + Documentation.xml = Assebly.dll with internal
interface documentation. just like Microsoft his assemblies.)
 
Back
Top