C#中除了C风格的注释外,还提供了3条斜杠(///)开头的注释,在这些注释中,可以把包含类型和类型成员的文档说明的XML标记放在代码中。
以下为标记说明:
| 标记 | 说明 |
|---|---|
| < c> | 把行中的文本标记为代码,例如 < c > int i = 10; < /c > |
| < code> | 把多行标记为代码 |
| < example> | 标记为一个代码示例 |
| < exception> | 说明一个异常类(编译器要验证其语法) |
| < include> | 包含其他文档说明文件的注释(编译器要验证其语法) |
| < list> | 把列表插入文档中 |
| < para> | 建立文档的结构 |
| < param> | 标记方法的参数(编译器要验证其语法) |
| < paramref> | 表示一个单词是方法的参数(编译器要验证其语法) |
| < permission> | 说明对成员的访问 (编译器要验证其语法) |
| < remarks> | 给成员添加描述 |
| < returns> | 说明方法的返回值 |
| < see> | 提供对另一个参数的交叉引用(编译器要验证其语法) |
| < seealso> | 提供描述中的”参见”部分(编译器要验证其语法) |
| < summary> | 提供类型或成员的简短小结 |
| < typeparam> | 用在泛型类型的注释中以说明一个类型参数 |
| < typepararef> | 类型参数的名称 |
| < value> | 描述属性 |
本文介绍了C#中使用XML标记进行代码注释的方法,包括各种标记如<c>、<code>、<example>等的使用场景及语法,帮助开发者更好地理解并应用这些注释标记。
402

被折叠的 条评论
为什么被折叠?



