-doc(C# 编译器选项)
-doc 选项可让你在 XML 文件中放置文档注释 。
语法
-doc:file
参数
file
XML 的输出文件(由编译的源代码文件中的注释填充)。
备注
在源代码文件中,可以处理以下内容之前的文档注释,并将其添加到 XML 文件中:
包含 Main 的源代码文件首先输出到 XML 中。
若要将生成的 xml 文件与 IntelliSense 功能配合使用,请将 .xml 文件的文件名设为与要支持的程序集相同的名称,然后确保 .xml 文件与程序集位于同一目录中。 这样,在 Visual Studio 项目中引用程序集时,也会找到 .xml 文件。 有关详细信息,请参阅提供代码注释。
除非用 -target:module 进行编译,否则 file
将包含 <assembly></assembly> 标记,以指定包含编译输出文件的程序集清单的文件名。
Note
-doc 选项适用于所有输入文件;或者,如果在项目设置中进行设置,则适用于项目中的所有文件。 若要禁用与特定文件或一段代码的文档注释相关的警告,请使用 #pragma 警告。
有关从代码中的注释生成文档的方法,请参阅建议的文档注释标记。
在 Visual Studio 开发环境中设置此编译器选项
打开项目的“属性” 页。
单击“生成” 选项卡。
修改“XML 文档文件” 属性。
有关如何以编程方式设置此编译器选项的信息,请参阅 DocumentationFile。