# /doc (C# Compiler Options) **/doc** 选项允许在 XML 文件中放置文档注释。 ## 语法 ``` /doc:file ``` ## 参数 _file_ XML 的输出文件，由编译的源代码文件中的注释填充。 ## 备注 在源代码文件中，可处理以下内容之前的文档注释，并将其添加到 XML 文件中： * 用户定义的类型，如 [class](https://msdn.microsoft.com/zh-CN/library/0b0thckt.aspx)、[delegate](https://msdn.microsoft.com/zh-CN/library/900fyy8e.aspx) 或 [interface](https://msdn.microsoft.com/zh-CN/library/87d83y5b.aspx) * 成员，如字段、[事件](https://msdn.microsoft.com/zh-CN/library/8627sbea.aspx)、[属性](https://msdn.microsoft.com/zh-CN/library/w86s7x04.aspx)或方法 包含 Main 的源代码文件首先输出到 XML。 若要将生成的 .xml 文件用于[Intellisense](https://msdn.microsoft.com/zh-CN/library/hcw1s69b.aspx)功能，请使该 .xml 文件的文件名与要支持的程序集同名，然后确保该 .xml 文件放入与该程序集相同的目录中。这样，在 Visual Studio 项目中引用程序集时，也可找到该 .xml 文件。有关更多信息，请参见[提供代码注释](https://msdn.microsoft.com/zh-CN/library/s0we08bk.aspx)。 除非用 [/target:module](https://msdn.microsoft.com/zh-CN/library/58scf68s.aspx) 进行编译，否则 _file_ 将包含 <assembly></assembly>，以指定包含编译输出文件的程序集清单的文件名。 |  注意 | | :-- | | /doc 选项适用于所有输入文件；或者，如果此选项是在“项目设置”中设置的，则适用于项目中的所有文件。若要禁用与特定的文件或代码段的文档注释相关的警告，请使用 [#pragma warning](https://msdn.microsoft.com/zh-CN/library/441722ys.aspx)。 | 有关从代码中的注释生成文档的方法，请参见[建议的文档注释标记](https://msdn.microsoft.com/zh-CN/library/5ast78ax.aspx)。 ## 在 Visual Studio 开发环境中设置此编译器选项 1. 打开项目的**“属性”**页。 2. 单击**“生成”**选项卡。 3. 修改**“XML 文档文件”**属性。 有关如何以编程方式设置此编译器选项的信息，请参见 [DocumentationFile](https://msdn.microsoft.com/zh-CN/library/t071996d.aspx)。 ## 请参阅 [C# Compiler Options](https://msdn.microsoft.com/zh-CN/library/2fdbz5xd.aspx) [如何：修改项目属性和配置设置](https://msdn.microsoft.com/zh-CN/library/z15yzzew.aspx)