C#为程序员提供一种机制,以使用包含 XML 文本的特殊注释语法记录其代码。
在源代码文件中,具有特定窗体的注释可用于指示工具从这些注释生成 XML,并将其置于后面。 使用此语法的注释称为文档注释。 它们必须紧跟在用户定义的类型(如类、委托或接口)或成员(如字段、事件、属性或方法)之前。
XML 生成工具称为文档生成器。 (此生成器可能是,但不一定是C#编译器本身。)文档生成器生成的输出称为 “文档文件”。 文档文件用作文档查看器的输入;一种用于生成类型信息及其关联文档的某种视觉显示方式的工具。
官方参考文档
文档注释使用方法
输入///
之后,输入文档标记,回车即可。
/// <summary>
/// This class performs an important function.
/// </summary>
<summary>
<summary>
标记应当用于描述类型或类型成员。 使用<remarks>
可针对某个类型说明添加补充信息。
<summary>description</summary>
参数:
- description:对象的摘要;
<param>
标记旨在供文档查看器用来显示有关某个类型或成员的其他信息。
<param name="name">description</param>
参数:
- name:方法参数的名称,使用双引号将名称引起来;
- description:参数说明;
在方法声明的注释中,应使用 <param>
标记来描述方法参数之一。
若要记录多个参数,请使用多个 <param>
标记。
<return>
描述方法的返回值
<summary>description</summary>
参数:
- description:返回值说明