Inline-Code einbinden

Die folgenden Befehle werden verwendet, um Quellcode ohne Formatierung darzustellen. Der Quellcode beginnt in einer neuen Zeile, die im Code wiedergegeben wird.

\code

Die Befehle \code und \endcode schließen einen Quellcodeausschnitt ein.

Für die Dokumentation von Kommandozeilenanweisungen, Shell-Skripten oder anderen Inhalten, die nicht in einer von QDoc erkannten Qt-Sprache vorliegen, verwenden Sie stattdessen \badcode.

Bei der Verarbeitung des \code-Befehls entfernt QDoc alle Einrückungen, die für die wortwörtlichen Codeblöcke innerhalb eines /*! ... */ Kommentars üblich sind, bevor es die Standardeinrückung hinzufügt.

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

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

Andere QDoc-Befehle sind in \code... \endcode, und das Sonderzeichen '\' wird wie der übrige Code akzeptiert und wiedergegeben, es sei denn, es folgt eine Ziffer und es wurden Parameter an \code übergeben.

Hervorhebung und automatische Verlinkung

Die Befehle von \code versuchen, ihren Inhalt als Code einer bestimmten Sprache zu analysieren, wie sie in der Konfigurationsvariable language definiert ist. Dies ermöglicht die Hervorhebung und automatische Verknüpfung mit im Code erkannten Typen.

Als Ausnahme seit QDoc Version 6.4, wenn der \code Befehl innerhalb eines QML-spezifischen Themas verwendet wird, versucht QDoc zuerst, den Code als QML zu erkennen; für andere Themen hat die Sprachkonfigurationsvariable Vorrang. Um den Codeschnipsel explizit als QML zu markieren, verwenden Sie stattdessen den Befehl \qml.

Parameter für Codeausschnitte

Seit QDoc Version 5.12 akzeptiert der Befehl \code auch optionale Parameter. Parameter sind nützlich, um einfache Zeichenketten in den Codeschnipsel einzufügen. Um eine Zeichenkette an einer bestimmten Stelle im Snippet einzufügen, fügen Sie einen Backslash gefolgt von einer Ziffer (1..8) ein. Die Ziffern entsprechen der Reihenfolge der Argumentliste, in der die Argumente durch Leerzeichen getrennt sind.

Zum Beispiel:

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

Für den obigen Ausschnitt rendert QDoc das Wort hello in einem Kommentar im C-Stil.

Einbindung von Code aus externen Dateien

Um Codeschnipsel aus einer externen Datei einzubinden, verwenden Sie die Befehle \snippet und \codeline.

Siehe auch \c, \qml, \badcode, \quotefromfile und language.

\badcode

Ähnlich wie \code schließen die Befehle \badcode und \endcode Inhalte ein, die wortwörtlich in einem separaten Absatz wiedergegeben werden, aber es wird kein Parsing oder eine automatische Linkerstellung durchgeführt. Stattdessen wird der Inhalt als reiner Text behandelt.

Ersetzen Sie \code durch diesen Befehl, wenn Sie Befehlszeilenanweisungen, Shell-Skripte oder andere Inhalte dokumentieren, die nicht in einer Qt-Sprache vorliegen, aber dennoch ähnlich wie ein \code-Absatz gestylt werden sollen.

Wie \code akzeptiert auch \badcode optionale Parameter.

\qml

Die Befehle \qml und \endqml schließen einen QML-Quellcodeausschnitt ein. Sie dienen der Syntaxhervorhebung von QML-Codefragmenten. Das eingeschlossene Snippet muss vollständig sein, als ob es eine gültige .qml-Datei wäre. Wenn das Snippet unvollständig ist, gibt QDoc eine Warnung aus und ignoriert das Snippet.

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

Wie der Befehl \code akzeptiert auch \qml optionale Parameter.