Describing Class Methods

[Roshawn Dawson]

Hi All,

I am currently writing a class library with VB.NET. I've noticed that
when creating a web service in .NET I can give each web method a
description via the WebMethod attribute. However, when creating a simple
class library, I haven't found out how to do it. For now I've resorted
to using comments in my code. So if someone else were to use my
library, how could they tell what method does what?

Take, for instance, the methods of the SqlConnection class. The
descriptions for each method appears in the intellisense menu when the
mouse is hovered over it. This is what I'm trying to accomplish.

Can anyone point me in the right direction?

Thanks,
Roshawn

 

[Cor Ligthert]

Roshawn,

When I understand you well, than is now only in C#, it will be in whidbey VB
as well.

Now you can use this, however I don't know how they are compatible to the
will be version.

From Herfrieds, 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>

I hope this helps?

Cor

 

[Herfried K. Wagner [MVP]]

I am currently writing a class library with VB.NET. I've noticed that
when creating a web service in .NET I can give each web method a
description via the WebMethod attribute. However, when creating a simple
class library, I haven't found out how to do it. For now I've resorted to
using comments in my code. So if someone else were to use my library, how
could they tell what method does what?

Adding IntelliSense tooltips, XML comments, and documentation
<URL:http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en>