宏

使用宏变量来创建您自己的简单 QDoc 命令。

宏可用于：

• 将重复出现的文本（例如格式化的文本片段）插入到文档中。
• 将信息（如版本字符串）从构建系统引入到 .documentation 中。
• 将未来可能发生变化的字符串（例如产品名称）集中管理在一个位置。
• 确保术语或产品名称的使用保持一致。
• 使用 HTML 和 DocBook 元素（例如强制换行和特殊字符）来设置生成的文档样式。
• 使用制表符来显示不同编程语言、操作系统或工具的内容示例等。

全局宏

有关可在所有文档项目中使用的一组预定义全局宏及其当前值，请参阅/qtbase/doc/global/macros.qdocconf和/qtbase/doc/global/htmltabs.qdocconf。其中包含的宏包括：

• CMake 代码片段
• HTML 和 DocBook 格式设置
• 产品名称
• 产品版本
• 标签式内容
• YouTube 内容链接
• 其他宏

Qt Online Installer 将宏文件复制到您的 Qt 安装文件夹中，因此即使您使用已安装的 Qt 中的 QDoc 来构建文档（而不是自己从源代码构建 QDoc），也可以使用这些宏。

添加宏

您可以在特定文档项目的 .qdocconf 文件中，或该项目引用的任何 .qdocconf 文件中添加宏。如果某个宏在多个文档项目中都可能派上用场，请将其添加到全局宏文件中。

有关宏语法和选项的更多信息，请参阅macro。

使用宏

您可以在以下位置以与内置 QDoc 命令相同的方式使用宏：

• 源代码文件中的文档注释（.cpp、.qml）
• 文档源文件（.qdoc、.qdocinc）

例如：

\QOI copies the macros files to your Qt installation folder.

已弃用的宏

全局宏文件中包含以下已弃用的宏，以保持与旧版文档集的兼容性。