通过

-医生

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

语法

-doc[+ | -]

或

-doc:file

论据

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

注解

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

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

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

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

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

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

示例：

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

另请参阅