Simple Query: Visual Studio Class Documentation

  • Thread starter Thread starter Nick Stansbury
  • Start date Start date
N

Nick Stansbury

Hi,
Easy if you know how I'm sure - working in VS2003 - you get a very handy
tooltip / documentation prompt for built in functions / methods etc.

i.e. If you type [ HttpContext.Current.GetAppConfig( ] you get along with
details about the possible overloaded calls information about each parameter
(in this case you get [ Name: The application tag that..... ]

How do you write these for your own classes / functions etc. ?

Don't need detailed help (nice if you want to give it!) - but can someone
point me in the right direction please?

Many thanks

Nick Stansbury
 
Is this what you wanted?

You'll find that if you type
///<summary>Description of the Function</summary>
above your methods/properties, that the IDE will pick them
up and show them as tooltip info


NB: That's 3 slashes in C# -- not 2 as is traditional....
 
Back
Top