XML 文档 (Visual C++)

在 Visual C++ 中,你可以将注释添加到处理到 XML 文档文件的源代码中。 之后,可在为代码中的类创建文档的进程中输入此文件。

在 Visual C++ 代码文件中,XML 文档注释必须位于方法或类型定义之前。 下述情况下,可在 IntelliSense QuickInfo 数据提示中填写注释:

  1. 当代码编译为带有 WINMD 文件的 Windows 运行时组件时

  2. 当前项目包含源代码时

  3. 在其类型声明和实现位于同一头文件的库中

注意

在当前发布版本中,不在模板或包含模板类型的任何内容(例如将参数作为模板的函数)上处理代码注释。 添加此类注释将导致未定义的行为。

若要详细了解如何创建带文档注释的 XML 文件,请参阅以下文章。

有关以下方面的信息 请参阅
要使用的编译器选项 /doc
可用于在文档中提供常用功能的标记 建议的文档注释标记
编译器生成的用于标识代码中构造的 ID 字符串 处理 XML 文件
如何分隔文档标记 Visual C++ 文档标记的分隔符
基于一个或多个 XDC 文件生成 XML 文件。 XDCMake 参考
与 Visual Studio 功能区有关的 XML 相关信息的链接 Visual Studio 中的 XML

如果需要在文档注释的文本中添加 XML 特殊字符,必须使用 XML 实体或 CDATA 节。

另请参阅

适用于运行时平台的组件扩展