C# 语言规范 - 建议的标记
文档生成器必须接受和处理任何根据 XML 规则有效的标记。下列标记提供了用户文档中常用的功能。(当然,也可能有其他标记。)
标记 | 章节 | 用途 |
---|---|---|
<c> |
B.2.1 | 将文本设置为类似代码的字体 |
<code> |
B.2.2 | 将一行或多行源代码或程序输出设置为某种字体 |
<example> |
B.2.3 | 表示所含的是示例 |
<exception> |
B.2.4 | 标识方法可能引发的异常 |
<include> |
B.2.5 | 包括来自外部文件的 XML |
<list> |
B.2.6 | 创建列表或表 |
<para> |
B.2.7 | 用于将结构添加到文本中 |
<param> |
B.2.8 | 描述方法或构造函数的参数 |
<paramref> |
B.2.9 | 确认某个单词是参数名 |
<permission> |
B.2.10 | 描述成员的安全性和访问权限 |
<remarks> |
B.2.11 | 描述一种类型 |
<returns> |
B.2.12 | 描述方法的返回值 |
<see> |
B.2.13 | 指定链接 |
<seealso> |
B.2.14 | 生成“请参见”项 |
<summary> |
B.2.15 | 描述类型的成员 |
<value> |
B.2.16 | 描述属性 |