473,883 Members | 2,116 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

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.Compone ntModal.Descrip tion("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.Compone ntModal.Descrip tion("This function kicks aars!")> Function
KickAars(<Syste m.ComponentModa l.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 3439
BoonHead, The Lost Philosopher <bo******@savag etiger.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.co m>
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.co m> wrote in message news:MP******** *************** *@news.microsof t.com...
BoonHead, The Lost Philosopher <bo******@savag etiger.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.co m>
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******@savag etiger.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.co m>
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.co m> wrote in message
news:MP******** *************** *@news.microsof t.com...
BoonHead, The Lost Philosopher <bo******@savag etiger.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.co m>
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.x ml = Assebly.dll with internal
interface documentation. just like Microsoft his assemblies.)

"Jon Skeet" <sk***@pobox.co m> wrote in message
news:MP******** *************** *@news.microsof t.com...
BoonHead, The Lost Philosopher <bo******@savag etiger.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.co m>
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
1828
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 the interface?
3
3600
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 be "public interface Value{}" in Java! class IntValue : public Value{ private: int _value; public:
2
1761
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 format. My problem with Python is that there are so many tools and formats ... I don't know which one I should use. I've tried to figure out if there is one that is the "de-facto standard" but ... Could someone advice me on what format/tool I...
1
13661
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 serialize interface IBusinessProcess
11
2229
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 interface that defines all a forms methods etc. In the example below "System.Windows.Forms.Form" isn't an interface, but it gets my point across. Is there an interface for a form that I can substitute here? Thank you again Tony
2
2164
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 that I use for acquiring the function names, scope, parameters, etc. Is there an "InheritedClassType" or "InterfaceType" property that I can query? I've tried using DeclaringType.BaseType, but that doesn't seem to give me what I want. ...
5
295
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: <System.ComponentModal.Description("This property sets aars!")> Property Aars() As Boolean '...Property body... End Property
4
2409
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 used by one master class that is public. I am able to declare the interface as "internal interface" without problem but when I attempt to use it by declaring a class that implements it, if I declare the implemented interface members as...
0
1380
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. One of the interfaces has been defined as follows: Public Interface IPlugin
0
9945
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, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
11160
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
10766
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 tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
1
10863
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
1
7978
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
5807
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
1
4622
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
4230
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
3241
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.