473,387 Members | 1,897 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,387 software developers and data experts.

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

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
Jul 21 '05 #1
5 3395
BoonHead, The Lost Philosopher <bo******@savagetiger.org> wrote:
Does anyone know how to implement internal interface documentation for
functions and parameters?


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/

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too
Jul 21 '05 #2
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"...

"Jon Skeet" <sk***@pobox.com> wrote in message news:MP************************@news.microsoft.com ...
BoonHead, The Lost Philosopher <bo******@savagetiger.org> wrote:
Does anyone know how to implement internal interface documentation for
functions and parameters?


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/

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

Jul 21 '05 #3
BoonHead, The Lost Philosopher <bo******@savagetiger.org> wrote:
I have no idea of how to implement this.


Did you download the plug-in I directed you to and read the
documentation?

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too
Jul 21 '05 #4
Yes, I have downloaded it.
Thanx van the URL.

I'm gonna read the documantary at home.

"Jon Skeet" <sk***@pobox.com> wrote in message
news:MP************************@news.microsoft.com ...
BoonHead, The Lost Philosopher <bo******@savagetiger.org> wrote:
I have no idea of how to implement this.


Did you download the plug-in I directed you to and read the
documentation?

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

Jul 21 '05 #5
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.)

"Jon Skeet" <sk***@pobox.com> wrote in message
news:MP************************@news.microsoft.com ...
BoonHead, The Lost Philosopher <bo******@savagetiger.org> wrote:
I have no idea of how to implement this.


Did you download the plug-in I directed you to and read the
documentation?

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

Jul 21 '05 #6

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

2
by: seesaw | last post by:
When define an interface of all pure virtual functions, will the destructor of it will automatically virtual, or it has to be declared as virtual? Should it be declared as "virtual" when defining...
3
by: Markus Dehmann | last post by:
I have a two different value types with which I want to do similar things: store them in the same vector, stack, etc. Also, I want an << operator for each of them. class Value{}; // this would...
2
by: Kalle Anke | last post by:
I'm confused of how I should document my code, I've always liked being able to document my code directly in my source file and then to use some tool to extract the documentation to some other...
1
by: n_o_s_p_a__m | last post by:
My web service has a webmethod whose return type is declared as an interface type, for example: public IBusinessProcess GetBusinessProcess() {} which generates the lovely error: Cannot...
11
by: Antony | last post by:
I know this sounds stupid but I am going to carry on anyway. I want to create an interface that implements all methods of a form, plus another one or two. But I need to know if there is an...
2
by: Rob | last post by:
I'm using reflection to inspect a class and its methods. Is is possible to determine if the class is a derived class or an interface implementation? I'm using the MethodInfo object for relfection...
5
by: BoonHead, The Lost Philosopher | last post by:
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:...
4
by: ~~~ .NET Ed ~~~ | last post by:
I am facing a problem. My project is composed of several assemblies. In one of them -the backend- I have several internal classes that must implement an interface. These internal classes are only...
0
by: Peter | last post by:
Hi I'm stuck and would appreciate some help. I have created a Class library project that contains a number of interface definitions that must be used by a range of other VB.NET applications. ...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.