Question

I want to be able to decorate classes and methods with the text that intellisense shows when you are instantiating the class or accessing a field.

For example, I want to give usage instructions.

I can’t find the appropriate decoration for this. How do I do it?

Answer 1

Just add this to the top of your class definition…

/// <summary>
/// Returns a pointless string
/// </summary>
/// <param name="name">Parameter to personalise the rubbish returned</param>
/// <returns>Utter junk is returned</returns>

Where summary is what is shown for the class description, a param node for each element which describes each parameter and return statement describing what’s returned.