更新:2007 年 11 月

在 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:文档注释

请参见