question about class attributes

If you open the object browser and look at microsft's classes, in the lower pane of the browser it shows comments about the selected class, and then if you select a class member, it shows info about the selected member.

Summaries and even argument info and return value info are shown. Also I see simiar if not identical information when intellisense pops up info about selected classes and their members when I'm coding.....

The questions is.....How can i do that Are their class/member attributes at work here or what And if so, what and where are they And where do I employ them so that i can produce the same functionality

Thanks in advance.

-Andy Moyer

Answer this question

question about class attributes

Grigory Bushuev
Are you using nDoc after you build your project to combine the project output with the xml document
MavecO
hi, thanks for your help. i'm still having trouble though. my problem is that i add the comments with the VBCommenter and build my project, but I still can't see the the comments such as the summary or remarks in the object browser nor in intellisense. What else do i need to do to make this work please help, thanks.

-Andy Moyer
Jeff G87474
no, the intellisense documentation is just for internal use while i'm developing apps
otherwise i dont know what i had made some time ago
its just to refresh my memory
Samster
i read in the help of vbcommenter that you must realod the project again
if i do that it still doesnt work , but i do this:

i am currently building a class library and a test app
if i want to see the comments from the lib in the test app i close the IDE, copy the xml file from the bin dir of the lib to the bin dir of the app
then it usually works fine

i guess your situation is different but hope this helps
Fred Malone
VBCommenter PowerToy is the tool you need:

http://www.gotdotnet.com/workspaces/releases/viewuploads.aspx id=112b5449-f702-46e2-87fa-86bdf39a17dd

You'll also need NDoc.

The workspace on GotDotNet can be hard to get to; but keep refreshing and it will eventually display.

This tool has a few bugs (I'd really like to see the HTML parsing in the comments improved) but all-in-all it is a great tool for VB developers.
gedmac
That text comes from the XML documentation for those classes. If you're using C#, you add XML doc comments like this:
/// <summary>
/// This method does such and such.
/// </summary>
/// <param name="arg">Specify how much such and such to do</param>
public void DoSuchAndSuch(string arg){ ... }To build the doc files, go into your project's properties and specifiy an ouptut file under Configuration Properties -> Build -> Ouputs -> XML Doumentation File

There is no built-in support for the current version of VB.NET, but there are third-party tools available that will let you add XML documentation. I think there is something on <a href="www.gotdotnet.com">GotDotNet</a>, but I can't find it at the moment because the sight seems to be down.
VbArch
thank you, i'll look into it when i get some time. thanks again.

-andy moyer
question about class attributes

Answer this question