XML 文档注释（C# 编程指南）

在 Visual C# 中，可以为代码创建文档，方法是在 XML 标记所指的代码块前面，直接在源代码的特殊注释字段中包括 XML 标记。例如：

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

使用 /doc 进行编译时，编译器将在源代码中搜索所有的 XML 标记，并创建一个 XML 文档文件。

备注

XML doc 注释不是元数据；它们不包括在编译的程序集中，因此无法通过反射对其进行访问。

本节内容

• 建议的文档注释标记

• 处理 XML 文件

• 文档标记分隔符

• 如何：使用 XML 文档功能

相关章节

有关更多信息，请参见：

• /doc（处理文档注释）

• “XML 文档”示例

C# 语言规范

有关更多信息，请参见 C# 语言规范中的以下各章节：

• 附录 A：文档注释

请参见

概念

C# 编程指南