XML 文档注释（C# 编程指南）
使用 C#，可以通过以下方式为代码创建文档：将特殊注释字段中的 XML 元素包含在源代码中注释引用的代码块的前面，例如：
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass {}
使用 -doc 选项进行编译时，编译器会在源代码中搜索所有 XML 标记，并创建一个 XML 文档文件。 若要基于编译器生成的文件创建最终文档，可以创建一个自定义工具，也可以使用 DocFX 或 Sandcastle 等工具。
若要引用 XML 元素（例如，你的函数将处理你要在 XML 文档注释中描述的特定 XML 元素），你可使用标准引用机制（< 和 >）。 若要引用代码引用 (cref) 元素中的通用标识符，可使用转义字符（例如，cref="List<T>"）或大括号 (cref="List{T}")。 作为特例，编译器会将大括号解析为尖括号以在引用通用标识符时使作者能够更轻松地进行文档注释。
Note
XML 文档注释不是元数据；它们不包括在编译的程序集中，因此无法通过反射对其进行访问。
本节内容
相关章节
有关详情，请参阅：
C# 语言规范
有关详细信息，请参阅 C# 语言规范。 该语言规范是 C# 语法和用法的权威资料。