XML 文档注释(C# 编程指南)

在 Visual C# 中,可以通过以下方法为代码创建文档:紧接在源代码中 XML 标记引用的代码块的前面,使用特殊的注释字段包括 XML 标记。 例如:

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

使用 /doc 进行编译时,编译器将在源代码中搜索所有的 XML 标记,并创建一个 XML 文档文件。 若要基于编译器生成的文件创建最终文档,可以创建一个自定义工具,也可以使用 Sandcastle 等工具。

提示

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

本节内容

相关章节

有关更多信息,请参见:

C# 语言规范

有关更多信息,请参见 C# 语言规范。C# 语言规范是 C# 语法和用法的权威资料。

请参见

概念

C# 编程指南