Building Documentation Comments in C#
February 26th, 2008 Posted in Programming
C# allows developers to embed XML comments into their source files, in order to provide additional information for other developers. Take a look at the example below:
You can see that there some descriptions for the class System.String. Actually, this can be done by the insertion of XML comments into your source codes. These XML comments start with three forward slashes (///), where the first two signify a comment and the third one informs the parser that this is an XML comment.
/// <summary>
/// Perform a test function
/// </summary>
/// <param name="TestingString">Testing String</param>
/// <returns>string</returns>
Your description should be appeared on the screen now :)
For more information, please visit to this site. Besides that, you also can check the Recommended Tags for Documentation Comments at MSDN library.
