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> ///summary description ///</summary> ///<remarks> ///This is a test. ///</remarks>
In the code structure for the Class1, the information listed within the <summary></summary> tags appears in the Description column. The information listed within <remarks></remarks> tags appears on the detailed page for class1 in the Remarks section
No comments:
Post a Comment