建议的文档注释标记(C# 编程指南)
C# 编译器处理代码中的文档注释,将它们设置为 XML 文件格式,其文件名在 /doc 命令行选项中指定。若要创建基于编译器生成的文件的最终文档,您可以创建自定义工具,也可以使用诸如等工具 约定。
在代码构造(如类型和类型成员)上处理标记。
注意 |
---|
文档注释不能应用于命名空间。 |
编译器将处理任何为有效 XML 的标记。下列标记提供了用户文档中常用的功能。
标记
<c> | <para> | <see>* |
---|---|---|
<code> | <param>* | <seealso>* |
<example> | <paramref> | <summary> |
<exception>* | <permission>* | <typeparam>* |
<include>* | <remarks> | <typeparamref> |
<list> | <returns> | <value> |
(* 表示编译器验证语法。)
如果想要尖括号出现在文档注释文本中,使用 < 和 >。如下面示例所示。
/// <summary cref="C < T >">
/// </summary>