How do I add descriptions to public functions?

J

JR

I would like to know how to add descriptions to functions in.Net so that
intellisence will show it when calling it?

Basically, is there an equivalent to <WebMethod(Description:="Function
returns Foo")> for non webservice functions?

Thanks,
Jamie
 
S

Suresh

On the line above your funtion in your code type ///
(forward slashes) and .NET will automatically add XML
description for the function summary, it's parameters and
return values if any. Then just fill them up. When you
scroll over the function from your caller you'll see you
descriptions.

HTH,
Suresh.
 
H

Hans Kesting

Suresh said:
On the line above your funtion in your code type ///
(forward slashes) and .NET will automatically add XML
description for the function summary, it's parameters and
return values if any. Then just fill them up. When you
scroll over the function from your caller you'll see you
descriptions.

You might need to change the project-properties: under "Configuration
Properties",
"Build" you need to enter a filename for "XML Documentation File".
Usually (?) this should be the project name with a ".xml" extension.

And do a "rebuild" to update the documentation.

Hans Kesting
 

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

Members online

Forum statistics

Threads
473,744
Messages
2,569,482
Members
44,901
Latest member
Noble71S45

Latest Threads

Top