宏

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

宏对于以下情况非常有用

• 在文档中加入重复出现的文本，如格式化文本片段。
• 将版本字符串等信息从构建系统调入 .文档。
• 为将来可能更改的字符串（如产品名称）保留单一位置。
• 确保术语或产品名称的使用保持一致。
• 通过使用 HTML 和 DocBook 元素（如强制换行和特殊字符）来设计生成文档的样式。
• 使用制表符显示不同编程语言、操作系统或工具的内容示例。

全局宏

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

• CMake 文本片段
• HTML 和 DocBook 格式化
• 产品名称
• 产品版本
• 标签内容
• 指向 YouTube 内容的链接
• 杂项宏

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

添加宏

你可以在特定文档项目的 .qdocconf 文件或你包含在其中的任何 .qdocconf 文件中添加宏。如果宏在多个文档项目中都有用，可将其添加到全局宏文件中。

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

使用宏

宏的使用方法与 QDoc 内置命令相同：

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

例如

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

过时的宏

全局宏文件包含以下过时宏，以便与旧文档集兼容。