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 \badcode stattdessen.

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 innerhalb von \code... deaktiviert. \endcode und das Sonderzeichen "\" wird akzeptiert und wie der übrige Code wiedergegeben, es sei denn, es folgt eine Ziffer und es wurden Parameter an \code übergeben.

Hervorhebung und automatische Verlinkung

Der Befehl \code versucht, seinen Inhalt als Code einer bestimmten Sprache zu analysieren, wie sie in der Konfigurationsvariable language definiert ist. Dadurch werden die im Code erkannten Typen hervorgehoben und automatisch verlinkt.

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 \qml Befehl stattdessen.

Ab Version 6.11 kann eine Sprache als optionales Argument ohne Berücksichtigung der Groß- und Kleinschreibung in der gleichen Zeile wie der Befehl \code angegeben werden. Wenn sie angegeben wird, überschreibt die Sprache die Standardsprache und jedes andere oben beschriebene sprachspezifische Verhalten. QDoc definiert auch die Sprache text, so dass Codeblöcke ohne Markierung oder Hervorhebung angezeigt werden können.

Zum Beispiel:

\code [text]
    # This is an example of unmarked code.
    implement MyModule;
    include "sys.m";
    sys: Sys;
\endcode

Dies kann nützlich sein, wenn eine Sprache zitiert wird, die QDoc nicht auszeichnen kann.

Alternativ können Sie eine Sprache für einen Codeblock angeben, den QDoc nicht erkennt, indem Sie die Sprache in die Liste der Konfigurationsvariablen codelanguages aufnehmen. Dies ermöglicht die Aufnahme von Metadaten in das generierte HTML, die von anderen Tools zur Syntaxhervorhebung des Codes verwendet werden können.

Code-Schnipsel-Parameter

Seit QDoc Version 5.12 akzeptiert der Befehl \code auch optionale Parameter. Parameter sind nützlich, um einfache Zeichenketten in das Code-Snippet 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 und auf jedes optionale Sprachargument folgen.

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 \snippet und \codeline Befehle.

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

\badcode

Ähnlich wie bei \codeumschließen die Befehle \badcode und \endcode den Inhalt, der wortwörtlich in einem separaten Absatz wiedergegeben wird, 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 verfasst sind, aber dennoch ähnlich wie ein \code -Absatz formatiert werden sollen.

Wie \code akzeptiert auch \badcode optionale Parameter.

\qml

Die Befehle \qml und \endqml umschließen einen Ausschnitt des QML-Quellcodes. Verwenden Sie diese für die korrekte 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 \code Befehl, \qml akzeptiert optionale Parameter.