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

使编译器对源代码文件中的文档注释进行处理,并为每个具有文档注释的源代码文件创建一个 .xdc 文件。

/doc[name]

Arguments

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

备注

使用 xdcmake.exe 将 .xdc 文件处理为一个 .xml 文件。 有关详细信息,请参阅XDCMake 参考

可以将文档注释添加到源代码文件中。 有关详细信息,请参阅建议用于文档注释的标记 (Visual C++)

/doc/clr:oldSyntax 不兼容。有关更多信息,请参见/clr(公共语言运行时编译)

若要在 IntelliSense 中使用生成的 .xml 文件,就要使 .xml 文件与要支持的程序集具有相同的文件名,并使 .xml 文件与该程序集处于同一目录中。 当在 Visual Studio 项目中引用该程序集时,也可以找到该 .xml 文件。 有关更多信息,请参见使用 IntelliSense提供 XML 代码注释

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

  1. 打开项目的**“属性页”**对话框。 有关详细信息,请参见如何:打开项目属性页

  2. 展开**“配置属性”**节点。

  3. 展开**“C/C++”**节点。

  4. 选择**“输出文件”**属性页。

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

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

请参见

参考

编译器选项

设置编译器选项