VB.NET Class Description?

  • Thread starter Marc Castrechini
  • Start date
M

Marc Castrechini

If I knew the official name name of this I would probably have better luck
looking for it.

How do I add Method and Property descriptions to my classes so the
description will be available when someone is using the class and highlights
one of them.

Obviously by default it shows the definitions of all overloaded instances
but I was hoping to add descriptions as well.

TIA
- Marc Castrechini
(e-mail address removed)
 
V

Vikas Ahuja

As far as I know, VB.NET does not allow for that. In C#, you can add a
/// <summary> node but there is no such provision in VB.NET.

Vikas
 
P

Peter Huang

Hi Marc,

Thanks for posting in the community.

First of all, I would like to confirm my understanding of your issue.
From your description, I understand that you wants to use the xml comment
which is available in C#.
Have I fully understood you? If there is anything I misunderstood, please
feel free to let me know.

I agree with Vikas's suggestion.
Visual Basic .NET doesn't support XML Comments in the IDE currently, but we
will in the future. There is an add-in that you can use
today, check it out at:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnvssamp/ht
ml/vbcs_XMLComments.asp

Best regards,

Peter Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.
 
M

Marc Castrechini

That link does not seem to work for me. Did it change? Or could you
perhaps tell me the TOC tree path?

- Marc
 
P

Peter Huang

Hi Marc,

Thanks for your quickly reply!

I am sorry and it seems to that the link seems to be broken, and you can
find the VB Commenter in the URL below and I have confirmed that the link
should work.
http://www.gotdotnet.com/team/ide/

Search the VB Commenter.

VB Commenter
Adding comments to your Visual Basic source code has never been easier.
After installing this PowerToy, you can type ''' followed by Enter in the
VB code editor and the appropriate XML-style comment tags will appear. You
can even create an XML file of all comments in a given class library, ready
to use with the Custom Help Builder PowerToy. Now you can quickly create a
professional help package to support your Visual Basic solution.

If you still have any concern on this issue ,please feel free to post here.

Best regards,

Peter Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top