C#程序代码注释

在源程序代码中加上注释是优秀编程人员应该养成的好习惯。C#中添加注释的方法有多种，不过最有特点的是可以使用XML的格式添加注释，从而减少了许多复杂的工作，也避免了注释和说明文件不一致的情况。

1. 常规注释方式

（1）单行：以“//”符号开始，任何位于“//”符号之后的本行文字都视为注释。

（2）多行：以“/*”开始，“*/”结束。任何介于这两对符号之间的文字都视为注释。

2. XML注释方式

“///”符号是一种特殊的注释方式，只要在用户自定义的类型如类、接口或者类的成员上方，或者命名空间的声明上方加上注释符号“///”，系统就会自动生成对应的XML标记。例如：

/// <summary>
        ///
        /// </summary>
       /// <param name="i"></param>
       /// <param name="j"></param>
       /// <returns></returns>

public int Add(int i,int j)
       {
               return i + j;
       }

注意，使用XML注释方式时，为了让系统自动生成对应的注释标记，应该先编写方法，然后再在方法名的上方输入“///”，否则不会自动生成对应的参数注释等标记。

生成注释标记后，就可以在<summary>和</summary>之间添加方法的描述，在<param>和</param>之间添加参数的描述，在<returns>和</returns>之间添加返回值的描述。以后调用此方法时就可以在键入方法名和参数的过程中直接看到注释的内容。

下表是C#定义的XML注释元素的标记。

XML注释标记