Description Attributes 1

[benvegiard]

Hi Al...

I am writing some classes that will be re-used by other programmers, and I'd like to include summary descriptions for each Sub and Function and possibly some of the variables passed.

I can find Attribute's for doing this at a class and property level, but when I add the <Description("...") _ tag to a sub/function, they do not show up in the auto complete within the Visual Studio editor.

Does anyone know how to apply these tips to Sub/Functions?

Thanks,
Ben

 

[ThatRickGuy]

If you are talking about the tool tip popups that show up while the autocomplete list is showing... You can't in VB.Net 2k2 or 2k3. I beleive C# can in 2k3, and everything should be able to in 2k5

-Rick

----------------------
If you're about to post an ASP.Net question,
please don't do it in the VB.Net forum

http://www.ringdev.com

I believe in killer coding ninja monkeys.

 

[chiph]

There is a project on GotDotNet called VBCommenter which adds the ability to document your code like C# does.

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

Once you have these comments, you should (according to their docs) be able to run the generated XML file through the NDoc utility (

http://ndoc.sourceforge.net),

which can create MSDN, HTML Help, and other help style formats.

Chip H.


____________________________________________________________________
If you want to get the best response to a question, please read FAQ222-2244 first

 

[ThatRickGuy]

VBCommenter is nice, but slightly quirky. I use it to generate documentation, but it will occassionally cause a "Black box of impending doom" where a dos window will pop-up and then the IDE will crash. Turning off the insert comments and build XML files options while you are not documenting prevents them though.

The GotDotNet website is a royal PITA if you ask me. Half the times I try to check out the VBCommenter project for updates or posts or anything their site is screwed up. Projects are unavailable, or logon isn't working.

Annoyances aside, I would definately recommend VBCommenter/NDoc for writing solid code documentation in VS.Net 2k2 and 2k3. With NDoc 1.3 you can build the same help collections that VS.Net uses, and with the help deployment tool from Microsoft (I can't remember the acronym, I think it starts with VH) you can embed your documentation into VS.Net. This makes going over some code from last year soooo much easier.

-Rick

----------------------
If you're about to post an ASP.Net question,
please don't do it in the VB.Net forum

http://www.ringdev.com

I believe in killer coding ninja monkeys.