C#可以根据特定的注释自动创建XML格式的文档说明。这些注释都是单行注释,且以3个斜杠(///)开头。
编译器可以识别的标识符:
<c>把行标记为代码。
<code>把多行改为代码。
<example>标记一个代码示例。
<exception>说明一个异常类。
<include>包含其他文档说明文件的注释。
<list>把列表插入到文档说明。
<param>标记方法的参数。
<paramref>表示一个单词是方法的参数。
<permission>说明对成员的访问。
<remarks>对成员添加描述。
<returns>说明方法的返回值。
<see>提供对另一个参数的交叉引用。
<seealso>提供描述中的“参见”部分。
<summary>对类型或成员的小结。
<value>描述属性。