Adding Description to Functions

[freshonlineMax]

Hello! I want to add description to my functions that users who uses them can know what's its work, Like .Net framework functions. For an example when we type MessageBox instruction we see some descriptions about that. Please if you know about this Help Me. Thank You. -- modified at 1:42 Saturday 19th November, 2005

[Calvinix]

just type /// above the function name and type the comment there . i havent used it , but i heard one of my colleagues mention it a day ago..You can always try :-D

[Stefan Troschuetz]

Take a look at the following links: XML documentation on MSDN[^] NDoc Code Documentation Generator for .NET[^]

---

www.troschuetz.de

[Curtis Schlak]

Note, when filling out your documentation, only the information contained in the <summary> and <param> tags get put in the IntelliSense tooltips.

/// <summary>
/// When searching for the function, in the IntelliSense,
/// this summary gets shown
/// </summary>
/// <param name="param1">
/// When filling out the function's parameter list, this
/// information gets shown for param1
/// </param>
/// <param name="param2">
/// When filling out the function's parameter list, this
/// information gets shown for param2
/// </param>

"we must lose precision to make significant
statements about complex systems."
-deKorvin on uncertainty