文本标记

文本格式化命令指示文本的渲染方式。

\a（参数标记）

\a命令告诉QDoc下一个单词是正式的参数名。

如果正式参数未记录或拼写错误，则发出警告，因此在记录一个函数时，您应该在函数描述中按名称提及每个正式参数，前面带有\a命令。然后参数名将以斜体显示。

正式参数名称可以括在大括号内，但这不是必需的。

\c（代码字体）

\c命令用于在代码字体中渲染变量名、用户定义的类名和C++关键字（例如，int和for）。

该命令使用等宽字体格式化其参数。如果要渲染的代码字体文本中包含空格，请将整个文本括在大括号内。

\c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) : QWidget(parent)}

\c命令在其参数内接受特殊字符\，将其渲染为正常字符。因此，如果要使用嵌套命令，您必须使用电传打印（\tt）命令。

另请参阅\tt和\code。

\details（可折叠的）

\details和\enddetails命令生成一个带有一个

的

元素，用于控制隐藏/显示状态。

在生成HTML输出时，使用\details和\enddetails命令生成一个可折叠的<details> HTML元素。该命令接受一个可选的括在大括号中的摘要字符串。此可选参数指定了可见的细节标题。

例如，对于以下输入

/*!
    \details {QDoc details}
      \note You're looking at detailed information.
    \enddetails
*/

如果QDoc生成HTML，它将这些命令转换为

<summary>QDoc details</summary><div class="admonition note"><p><b>Note: </b>You're looking at detailed information.</p></div>

QDoc将其渲染为

QDoc细节

注意：您正在查看详细信息。

对于任何其他输出格式，QDoc将内容作为正常的段落生成，忽略摘要字符串。此命令是在Qt6.6中被引入到QDoc中的。

\div

\div和\enddiv命令用于限定一个大型或小型文本块（可能包括其他QDoc命令），应应用于它特殊格式化属性。

必须提供在大括号中的参数，如下面的QDoc注释所示。该参数不会被解释，而是用作QDoc输出的标签的属性。

例如，我们可能想要渲染一个内联图像，使其浮动到当前文本块右侧。

/*!
    \div {class="float-right"}
        \inlineimage qml-column.png
    \enddiv
*/

如果QDoc生成HTML，它将这些命令转换为

<div class="float-right"><p><img src="images/qml-column.png" /></p></div>

对于HTML，属性值 float-right 将引用风格.css文件中的一个条款，在这个例子中可能是

div.float-right
{
   float: right; margin-left: 2em
}

注意：注意\div 命令是可以嵌套的。

以下是一个示例，取自用于生成Qt 4.7的index.html的index.qdoc文件

\div {class="indexbox guide"}
    \div {class="heading"}
        Qt Developer Guide
\enddiv
    \div {class="indexboxcont indexboxbar"}
        \div {class="section indexIcon"} \emptyspan
        \enddiv
        \div {class="section"}
            Qt is a cross-platform application and UI
            framework. Using Qt, you can write web-enabled
            applications once and deploy them across desktop,
            mobile and embedded operating systems without
            rewriting the source code.
        \enddiv
        \div {class="section sectionlist"}
            \list
               \li \l{Getting Started}
               \li \l{Installation} {Installation}
               \li \l{how-to-learn-qt.html} {How to learn Qt}
               \li \l{tutorials.html} {Tutorials}
               \li \l{Qt Examples} {Examples}
               \li \l{qt4-7-intro.html} {What's new in Qt 4.7}
            \endlist
        \enddiv
    \enddiv
\enddiv

当所有类属性值都定义与用于渲染Qt文档的style.css文件中一样时，上面的示例将渲染为

Qt开发者指南

Qt是一个跨平台的应用程序和UI框架。使用Qt，你可以一次编写支持网页的应用程序，并将它们部署到桌面、移动和嵌入式操作系统，而无需重写源代码。

入门
安装
如何学习Qt
教程
示例
Qt 4.7的新特性

另请参阅\span。

\span

\span命令为一段小块文本应用特殊格式。

必须提供两个参数，每个参数用大括号，如下面的QDoc注释所示。第一个参数不被解释，但指定了QDoc输出的标签的格式属性。第二个参数是用特殊格式属性渲染的文本。

例如，我们可能希望渲染数字列表中每个元素的首单词为蓝色。

/*!
    Global variables with complex types:
\list 1
        \li \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
        \li \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
        \li \span {class="variableName"} {constComplex1} in globals.cpp at line 16
        \li \span {class="variableName"} {constComplex2} in globals.cpp at line 17
    \endlist
*/

variableName类引用你的style.css中的条款。

.variableName
{
    font-family: courier;
color: blue
}

使用上面显示的variableName条款，示例将渲染为

复杂类型的全局变量

mutableComplex1在globals.cpp的第14行
mutableComplex2在globals.cpp的第15行
constComplex1在globals.cpp的第16行
constComplex2在globals.cpp的第17行

注意：span命令不会导致新段落开始。

另请参阅\div。

\tt（电传字体)

\tt命令用等宽字体渲染其参数。此命令的行为与\c命令类似，区别在于\t允许你在参数中嵌套QDoc命令（例如\e、\b和\underline）。

/*!
    After having populated the main container with
    child widgets, \c setupUi() scans the main container's list of
    slots for names with the form
    \tt{on_\e{objectName}_\e{signalName}().}
*/

如果要在代码字体中渲染的文本包含空格，请将整个文本放在大括号中。

\tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}

另请参阅\c。

\b

\b命令用粗体字体渲染其参数。这个命令以前被称为\bold。

/*!
    This is regular text; \b {this text is
    rendered using the \\b command}.
*/

\br

\br命令强制换行。

\e（强调，斜体)

\e命令用特殊字体渲染其参数，通常是斜体。这个命令以前被称为\i，现在已弃用。

如果参数包含空格或其他标点符号，请将参数放在大括号中。

/*!
    Here, we render \e {a few words} in italics.
*/

如果你想在包含空格的参数中使用其他QDoc命令，你总是需要将参数放在大括号中。但QDoc足够智能，可以计算括号的数量，因此在以下情况下不需要括号

/*!
    An argument can sometimes contain whitespaces,
    for example: \e QPushButton(tr("A Brand New Button"))
*/

最后，尾随标点符号不包含在参数中，也不包含"'s"。

\sub

\sub命令用比正文基线低的字体渲染其参数。

/*!
    Definition (Range): Consider the sequence
    {x\sub n}\sub {n > 1} . The set

    {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}

    is called the range of the sequence.
*/

如果参数包含空格或其他标点符号，请将参数放在大括号中。

\sup

\sup命令用比正文基线高的字体渲染其参数。

/*!
    The series

    1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...

    is called the \i {geometric series}.
*/

如果参数包含空格或其他标点符号，请将参数放在大括号中。

\uicontrol

\uicontrol命令用于标记内容以供UI控件使用。当使用HTML时，输出将以粗体显示。

另请参阅\b。

\underline命令用于在其参数下方添加下划线。

/*!
    The \underline {F}ile menu gives the users the possibility
    to edit an existing file, or save a new or modified
    file, and exit the application.
*/

如果参数包含空格或其他标点符号，请将参数放在大括号中。

\\（双反斜杠）

\函数序列\\展开为一个单个反斜杠。

QDoc命令总是以单个反斜杠开头。要在文本中显示单个反斜杠，您必须键入两个反斜杠。如果您要显示两个反斜杠，则必须键入四个。

/*!
    The \\\\ command is useful if you want a
    backslash to appear verbatim, for example,
    writing C:\\windows\\home\\.
*/

但是，如果您文本要显示为等宽字体，可以使用\c命令替换，该命令接受并渲染反斜杠作为其他任何字符。例如

/*!
    The \\c command is useful if you want a
    backslash to appear verbatim, and the word
    that contains it written in a monospace font,
    like this: \c {C:\windows\home\}.
*/

–（连字符）

QDoc将双横线渲染为连字符。设计为使其输入显示为原始文本的QDoc标记命令（如\c命令）不会将双横线替换为连字符字符。例如

/*!
    The \\c command -- useful if you want text in a monospace font --
    is well documented.
*/

但是，其他命令可能需要转义连字符以确保QDoc按预期渲染输出。例如;

/*!
    This \l {endash-sequence}{link to the -- (endash) sequence}
    isn't escaped and QDoc therefore renders an endash in the link
    text. However, the escaped
    \l {endash-sequence}{link to the \-- (endash) sequence}
    renders both hyphens as intended.
*/

另请参阅---（长连字符）。

---（长连字符）

QDoc将三个连字符渲染为长连字符。设计为使其输入显示为原始文本的QDoc标记命令（如\c命令）不会将三个连字符替换为长连字符字符。例如

/*!
    The \\c command---useful when you want text to be rendered
    verbatim---is well documented.
*/

但是，其他命令可能需要转义连字符以确保QDoc按预期渲染输出。例如;

/*!
    This \l {emdash-sequence}{link to the --- (emdash) sequence}
    isn't escaped and QDoc therefore renders an emdash in the link
    text. However, the escaped
    \l {emdash-sequence}{link to the -\-- (emdash) sequence}
    renders both hyphens as intended.
*/

注意： 此示例中转义的命令序列是长连字符。这避免了输出中连字符与长连字符的连续出现。

另请参阅--（短连字符）。

标记命令文档结构