通过

-doc

  • 项目

将文档注释处理到一个 XML 文件中。

语法

-doc[+ | -]

or

-doc:file

自变量

术语 定义
+ | - 可选。 指定 + 或仅 -doc 会导致编译器生成文档信息并将其置于 XML 文件中。 指定 - 相当于未指定 -doc，因此不会创建任何文档信息。
file 如果使用 -doc:，则是必需的。 指定输出 XML 文件（由编译的源代码文件中的注释填充）。 如果文件名包含空格，请用引号 (" ") 括住该名称。

备注

-doc 选项控制编译器是否生成包含文档注释的 XML 文件。 如果使用 -doc:file 语法，file 参数会指定 XML 文件的名称。 如果使用 -doc 或 -doc+，编译器会从其正在创建的可执行文件或库中获取 XML 文件名。 如果使用 -doc- 或未指定 -doc 选项，则编译器不会创建 XML 文件。

在源代码文件中，文档注释可先于以下定义：

若要将生成的 XML 文件与 Visual Studio IntelliSense 功能配合使用，请将 XML 文件的文件名设为与要支持的程序集相同的名称。 确保 XML 文件与程序集位于同一目录中，以便在 Visual Studio 项目中引用此程序集时，也可以找到 .xml 文件。 IntelliSense 不需要 XML 文档文件来处理项目内或项目引用的项目中的代码。

除非使用 -target:module 进行编译，否则 XML 文件包含标记 <assembly></assembly>。 这些标记指定包含编译输出文件的程序集清单的文件的名称。

有关从代码中的注释生成文档的方法，请参阅 XML 注释标记。

在 Visual Studio 集成开发环境中设置 -doc
1. 在解决方案资源管理器中选择一个项目。 在 “项目” 菜单上，单击 “属性” 。
2. 单击“编译”选项卡。
3. 在“生成 XML 文档文件”框中设置值。

示例

有关示例，请参阅使用 XML 来记录代码。

请参阅