内联代码

以下命令用于无格式渲染源代码。源代码从新的一行开始，以代码形式展示。

注意：尽管这些命令大多用于渲染 C++ 代码，但 \snippet 和 \codeline 命令比其他命令更受青睐。这些命令允许用其他 Qt 语言绑定的等价代码片段替换文档中的 C++ 片段。

\code

\code 和 \endcode 命令包含的一段源代码。

注意：在句子中的短代码片段可以使用 \c 命令。而 \code 命令用于较长的代码片段。它在 html <pre> 元素中以单独的段落形式显示代码，并解析包含的片段，为代码中的任何已知类型创建链接。

对于文档化命令行指令、shell 脚本或任何 QDoc 识别的 Qt 语言之外的任何内容，请使用 \badcode。

在处理 \code 命令时，QDoc 删除了在它之前添加标准缩进之前通用的代码块缩进。

注意：这不适用于使用 \quotefromfile 或 \quotefile 命令的外部引用代码。

/*!
    \code
        #include <QApplication>
        #include <QPushButton>

        int main(int argc, char *argv[])
        {
            ...
        }
    \endcode
*/

在 \code... \endcode 内部禁用了其他 QDoc 命令，并且特殊字符 '\' 可以接受并以与代码中其余部分相同的方式显示，除非它后面跟着一个数字并且传递了 \code 参数。

突出显示和自动链接

\code 命令尝试将其内容解析为特定语言，如 language 配置变量中定义的语言。这提供了代码中检测到的类型的突出显示和自动链接。

自 QDoc 版本 6.4 起作为例外，当 \code 命令在 QML 特定的 topic 中使用时，QDoc 首先尝试识别代码为 QML；对于其他主题，语言配置变量具有优先权。要显式标记代码片段为 QML，请使用 \qml 命令。

代码片段参数

自QDoc版本5.12开始，\code命令也接受可选参数。参数可用于将简单字符串注入代码片段中。要将字符串注入片段的特定位置，请添加一个反斜杠后跟一个数字（1..8）。数字对应于参数列表的顺序，其中参数由空格分隔。

例如

/*!
    \code * hello
    /\1 \2 \1/
    \endcode
*/

对于上述代码片段，QDoc将单词hello渲染为C风格的注释。

包含外部文件中的代码

要从外部文件包含代码片段，请使用\snippet和\codeline命令。

另请参阅\c、\qml、\badcode、\quotefromfile和language。

\badcode

与\code类似，\badcode和\endcode命令将内容包裹在一个单独的段落中，但这不会执行解析或自动链接创建。相反，内容被视为纯文本。

在文档说明命令行指令、shell脚本或其他不在Qt语言中，但应与\code段落类似风格的任何内容时，将\code替换为此命令。

与\code类似，\badcode也接受可选参数。

\qml

\qml和\endqml命令将QML源代码片段包裹起来。使用这些命令可为QML代码片段提供正确的语法高亮。包裹的片段必须完整，就像它是一个有效的.qml文件一样。如果片段不完整，QDoc将发出警告并忽略该片段。

/*!
    \qml
        import QtQuick 2.0

        Row {
            Rectangle {
                width: 100; height: 100
                color: "blue"
                transform: Translate { y: 20 }
            }
            Rectangle {
                width: 100; height: 100
                color: "red"
                transform: Translate { y: -20 }
            }
        }
    \endqml
*/

与\code命令类似，\qml也接受可选参数。

文档结构包含外部代码