宏

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

宏对于以下情况很有用

• 包含重复文本，例如格式化的文本片段，到文档中。
• 从构建系统中拉入信息，例如版本字符串，到 .documentation。
• 维护一个可能在未来更改的字符串的位置，例如产品名称。
• 确保一个术语或产品名称是一致使用的。
• 通过使用 HTML 和 DocBook 元素，例如强制换行和特殊字符，来调整生成文档的样式。
• 使用制表符显示不同编程语言、操作系统或工具的内容示例。

全局宏

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

• CMake 文本片段
• HTML 和 DocBook 格式化
• 产品名称
• 产品版本
• 标签内容
• 到 YouTube 内容的链接
• 其他宏

Qt 在线安装程序会将宏文件复制到您的 Qt 安装文件夹，因此即使您使用安装的 Qt（而不是从源代码构建 QDoc）构建文档，也可以使用宏。

添加宏

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

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

使用宏

您可以像在以下地方使用宏一样使用它们：

• 代码源文件、在文档注释 (.cpp, .qml)
• 文档源文件 (.qdoc, .qdocinc)

例如

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

过时宏

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