-doc-doc

将文档注释处理到一个 XML 文件中。Processes documentation comments to an XML file.

语法Syntax

-doc[+ | -]  

oror

-doc:file  

自变量Arguments

术语Term 定义Definition
+ | -+ | - 可选。Optional. 指定 + 或仅 -doc 会导致编译器生成文档信息并将其置于 XML 文件中。Specifying +, or just -doc, causes the compiler to generate documentation information and place it in an XML file. 指定 - 相当于未指定 -doc,因此不会创建任何文档信息。Specifying - is the equivalent of not specifying -doc, causing no documentation information to be created.
file 如果使用 -doc:,则是必需的。Required if -doc: is used. 指定输出 XML 文件(由编译的源代码文件中的注释填充)。Specifies the output XML file, which is populated with the comments from the source-code files of the compilation. 如果文件名包含空格,请用引号 (" ") 括住该名称。If the file name contains a space, surround the name with quotation marks (" ").

备注Remarks

-doc 选项控制编译器是否生成包含文档注释的 XML 文件。The -doc option controls whether the compiler generates an XML file containing the documentation comments. 如果使用 -doc:file 语法,file 参数会指定 XML 文件的名称。If you use the -doc:file syntax, the file parameter specifies the name of the XML file. 如果使用 -doc-doc+,编译器会从其正在创建的可执行文件或库中获取 XML 文件名。If you use -doc or -doc+, the compiler takes the XML file name from the executable file or library that the compiler is creating. 如果使用 -doc- 或未指定 -doc 选项,则编译器不会创建 XML 文件。If you use -doc- or do not specify the -doc option, the compiler does not create an XML file.

在源代码文件中,文档注释可先于以下定义:In source-code files, documentation comments can precede the following definitions:

若要将生成的 XML 文件与 Visual Studio IntelliSense 功能配合使用,请将 XML 文件的文件名设为与要支持的程序集相同的名称。To use the generated XML file with the Visual Studio IntelliSense feature, let the file name of the XML file be the same as the assembly you want to support. 确保 XML 文件与程序集位于同一目录中,以便在 Visual Studio 项目中引用此程序集时,也可以找到 .xml 文件。Make sure the XML file is in the same directory as the assembly so that when the assembly is referenced in the Visual Studio project, the .xml file is found as well. IntelliSense 不需要 XML 文档文件来处理项目内或项目引用的项目中的代码。XML documentation files are not required for IntelliSense to work for code within a project or within projects referenced by a project.

除非使用 -target:module 进行编译,否则 XML 文件包含标记 <assembly></assembly>Unless you compile with -target:module, the XML file contains the tags <assembly></assembly>. 这些标记指定包含编译输出文件的程序集清单的文件的名称。These tags specify the name of the file containing the assembly manifest for the output file of the compilation.

有关从代码中的注释生成文档的方法,请参阅 XML 注释标记See XML Comment Tags for ways to generate documentation from comments in your code.

在 Visual Studio 集成开发环境中设置 -docTo set -doc in the Visual Studio integrated development environment
1.在 “解决方案资源管理器” 中选择一个项目。1. Have a project selected in Solution Explorer. 在“项目”菜单上,单击“属性” 。On the Project menu, click Properties.
2.单击“编译” 选项卡。2. Click the Compile tab.
3.在“生成 XML 文档文件” 框中设置值。3. Set the value in the Generate XML documentation file box.

示例Example

有关示例,请参阅使用 XML 来记录代码See Documenting Your Code with XML for a sample.

请参阅See also