Adding a Method Description

[AccordingToDale]

Howdy all,

This is more a curiosity than a need....

Is it possible to add a description to a method so when you are coding and you reference that method you know just what that method does?

As an example, if you are using an intrinsic .NET method, say object.New(), when you type the '.' you get a list of properties and methods. When you highlight a method (or property) you'll get a brief description of the method.

Dale

 

[lucyv]

Did anyone ever respond to this? Does anyone know how to do this?

Thanks in advance,

-lucyv

 

[ThatRickGuy]

I'm 99% positive you can't in 2k2, I think you might be able to in 2k3 C# but not vb.Net, and I'm pretty sure you can in all languages in 2k5.

-Rick

VB.Net Forum forum796 forum855 ASP.NET Forum
I believe in killer coding ninja monkeys.

 

[chiph]

Did you look at the VB Code Commenter project at GotDotNet?

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

Once you have the .xml file that it produces, you can run NDoc against it to create your developer documentation.

Chip H.


____________________________________________________________________
Donate to Katrina relief:

http://s1.amazon.com/paypage/PELYGQVJ8Q7IB/103-6821258-5919825

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

 

[ThatRickGuy]

I use VB Commentor and nDoc. I would highly recommend it. You'll need to recompile the source and install to get it to run in VS 2k2, but it's a great tool for creating all of your code level documentation.

-Rick

VB.Net Forum forum796 forum855 ASP.NET Forum
I believe in killer coding ninja monkeys.