search c#.net

Chat With Me

คลิ๊กๆๆ...

Wednesday, July 1, 2009

Adding Comments in C# Code

Adding Comments in C# Code
You can easily add comments within the structure of your C# code and view them by using code comment Web reports. Comments and XML tags displayed in a code comment Web report are prefaced with the comment syntax ///. Typically, comments are entered before user-defined types such as a class, struct, or interface; members such as a field, event, property, or method; or a namespace declaration.
To add comments in C# code
Open a .cs file in an editor.
Switch to Code view.
Enter /// followed by any XML tags or text strings. If you enter /// on the line before the definition, the editor creates a template of a documentation comment and fills in the parameters and other information.
For example, in the file class1.cs before public Class1() you could enter the following:
///
///summary description
///

///
///This is a test.
///

In the code structure for the Class1, the information listed within the tags appears in the Description column. The information listed within tags appears on the detailed page for class1 in the Remarks section. For a list of supported XML tags

0 comments:

Post a Comment

Bejeweled

SNAKE Game - Top 20 Challenge

Learn c#.net

THE PRIMITIVE GAME - คนป่ามหาโหด