/doc（处理文档注释）(C/C++)

  • 项目

促使编译器处理源代码文件中的文档注释，并为每个包含文档注释的源代码文件创建 .xdc 文件。

语法

/doc[name]

参数

name
编译器将创建的 .xdc 文件的名称。 仅在编译中传递一个 .cpp 文件时有效。

备注

.xdc 文件将处理到具有 xdcmake.exe 的 .xml 文件中。 有关详细信息，请参阅 XDCMake 引用。

可以向源代码文件添加文档注释。 有关详细信息，请参阅 建议的文档注释标记。

若要将生成的 xml 文件与 IntelliSense 配合使用，请将 .xml 文件的文件名设为与要支持的程序集相同的名称，然后将 .xml 文件与程序集置于同一目录中。 在 Visual Studio 项目中引用程序集时，也会找到 .xml 文件。 有关详细信息，请参阅使用 IntelliSense 和应用 XML 代码注释。

在 Visual Studio 开发环境中设置此编译器选项

  1. 打开项目的“属性页” 对话框。 有关详细信息，请参阅在 Visual Studio 中设置 C++ 编译器和生成属性。

  2. 选择“配置属性”>“C/C++”>“输出文件”属性页 。

  3. 修改“生成 XML 文档文件”属性。

以编程方式设置此链接器选项

另请参阅

MSVC 编译器选项
MSVC 编译器命令行语法