How do I add descriptions to public functions?

  • Thread starter Thread starter JR
  • Start date Start date
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
 
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.
 
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.
Click to expand...

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
 
Back
Top