Включение кода в строку

Следующие команды используются для отображения исходного кода без форматирования. Исходный код начинается с новой строки и отображается в виде кода.

Примечание: Хотя большинство этих команд предназначены для отображения кода C++, команды \snippet и \codeline предпочтительнее других. Эти команды позволяют использовать эквивалентные фрагменты кода для других языковых связок Qt вместо фрагментов кода C++ в документации.

\code

Команды \code и \endcode заключают фрагмент исходного кода.

Примечание: Команда \c может использоваться для коротких фрагментов кода в предложении. Команда \code предназначена для более длинных фрагментов кода. Она отображает код дословно в отдельном абзаце в элементе html <pre> и анализирует заключенный фрагмент, создавая ссылки на любые известные типы в коде.

Для документирования командной строки, скриптов оболочки или любого содержимого, не относящегося к языку Qt, распознаваемому QDoc, используйте \badcode вместо этого.

При обработке любой из команд \code, \newcode или \oldcode QDoc удаляет все отступы, общие для фрагментов кода verbatim внутри /*! ... */ комментария перед добавлением стандартного отступа.

Примечание: Это не относится к внешнему коду, использующему команды \quotefromfile или \quotefile.

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

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

QDoc отображает это как:

#include <QApplication>
#include <QPushButton>

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

Другие команды QDoc отключены в \code... \endcode, и специальный символ '\' принимается и отображается как остальная часть кода.

Чтобы включить фрагменты кода из внешнего файла, используйте команды \snippet и \codeline.

См. также \c, \badcode, \quotefromfile, \newcode и \oldcode.

\badcode

Аналогично команде \code, команды \badcode и \endcode заключают содержимое, которое отображается дословно в отдельном абзаце, но никакого анализа или автоматического создания ссылок не выполняется. Вместо этого содержимое обрабатывается как обычный текст.

Замените \code этой командой при документировании командной строки, скриптов оболочки или любого другого содержимого, которое не относится к языку Qt, но должно быть стилизовано аналогично абзацу \code.

\newcode

Команды \newcode, \oldcode и \endcode позволяют показать, как перенести фрагмент кода в новую версию API.

Команда \newcode и её сопутствующая команда \oldcode - это удобная комбинация команд \code: эта комбинация предоставляет текст, связывающий два фрагмента кода.

Команда \newcode требует предшествующей команды \oldcode.

Как и команда \code, команда \newcode отображает свой код на новой строке в документации с помощью шрифта с фиксированным размером и стандартным отступом.

/ *!
    \oldcode
        if (printer->setup(parent))
            ...
    \newcode
        QPrintDialog dialog(printer, parent);
            if (dialog.exec())
                ...
    \ endcode
* /

QDoc отображает это как:

Например, если у вас есть код, похожий на

if (printer->setup(parent))
    ...

вы можете переписать его как

QPrintDialog dialog(printer, parent);
    if (dialog.exec())
        ...

Другие команды QDoc отключены в \oldcode ... \endcode, и символ '\' не нужно экранировать.

\oldcode

Команда \oldcode требует соответствующей команды \newcode; в противном случае QDoc не сможет обработать команду и выведет предупреждение.

См. также \newcode.

\qml

Команды \qml и \endqml заключают фрагмент исходного кода QML.

/ *!
    \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
* /

QDoc отображает это как:

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 }
    }
}