建议的文档注释标记(C# 编程指南)
C# 编译器处理代码中的文档注释,并在文件中将其设置为 XML 格式,该文件的名称通过 /doc 命令行选项指定 。 若要基于编译器生成的文件创建最终文档,可以创建一个自定义工具,也可以使用 DocFX 或 Sandcastle 等工具。
在类型和类型成员等代码构造中处理标记。
Note
不可对命名空间应用文档注释。
编译器将处理属于有效 XML 形式的任何标记。 下列标记提供用户文档的中常用功能。
Tags
<c> | <para> | <see>* | <value> |
<code> | <param>* | <seealso>* | |
<example> | <paramref> | <summary> | |
<exception>* | <permission>* | <typeparam>* | |
<include>* | <remarks> | <typeparamref> | |
<list> | <inheritdoc> | <returns> |
(* 表示编译器验证语法。)
如果希望在文档注释的文本中显示尖括号,请使用 <
和 >
的 HTML 编码,分别为 <
和 >
。 下面的示例对此编码进行了演示。
/// <summary>
/// This property always returns a value < 1.
/// </summary>