コードをインラインに含める

以下のコマンドは、ソース・コードを書式なしでレンダリングするために使用します。ソースコードは改行で始まり、コード内でレンダリングされます。

\code

\code と\endcode コマンドは、ソースコードのスニペットを囲みます。

コマンドライン命令やシェルスクリプト、あるいは QDoc が認識する Qt 言語以外のコンテンツを文書化する場合は、代わりに \badcodeを使用してください。

\code コマンドを処理するとき、QDoc は/*! ...*/ のコメント内の逐語的なコード・ブロックに共通なインデントをすべて削除してから、標準的なインデントを追加します。

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

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

他のQDocコマンドは\code...内では無効になります。\endcodeまた、特殊文字'˶'は、その後に数字が続き、パラメータが\code に渡されない限り、他のコードと同様に受け入れられ、レンダリングされます。

ハイライトとオートリンク

\code コマンドは、その内容を言語設定変数で定義された特定の言語のコードとして解析しようとします。これにより、コード内で検出された型の強調表示と自動リンクが行われる。

QDocバージョン6.4からの例外として、\code コマンドがQML固有のトピック内で使われた場合、QDocはまずコードをQMLとして認識しようとします。他のトピックでは言語設定変数が優先されます。他のトピックでは言語設定変数が優先されます。 \qmlコマンドを使用してください。

バージョン6.11からは、\code コマンドと同じ行に、大文字と小文字を区別しないオプションの引数として言語を指定できるようになりました。言語が指定されると、デフォルトの言語と上記の言語固有の動作が上書きされます。QDocはtext 言語も定義しているので、コードのブロックをマークアップやハイライトなしで表示することができます。

例えば

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

これはQDocがマークアップする機能を持っていない言語を引用するときに便利です。

あるいは、codelanguages設定変数が保持するリストに言語を含めることで、QDocが認識しないコード・ブロックの言語を指定することができます。これにより、生成されたHTMLにメタデータを含めることができ、他のツールでコードのシンタックスハイライトに使うことができます。

コード・スニペット・パラメーター

QDocバージョン5.12から、\code 、オプションのパラメータも使えるようになりました。パラメータはコード・スニペットに簡単な文字列を挿入するのに便利です。スニペット内の特定の場所に文字列を挿入するには、バックスラッシュの後に数字(1..8)を付けます。数字は引数リストの順番に対応しており、引数はスペースで区切られ、オプションの言語引数の後に続きます。

例えば

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

上記のスニペットでは、QDocはCスタイルのコメントで囲まれたhelloという単語をレンダリングする。

外部ファイルからのコードのインクルード

外部ファイルからコード・スニペットをインクルードするには \snippetと \codelineコマンドを使う。

参照 \c, \qml, \badcode, \quotefromfileおよび言語。

\badcode

と似ている。 \code\badcode と\endcode コマンドは、別の段落に逐語的にレンダリングされるコンテンツを囲むが、解析や自動リンク作成は行われない。代わりに、コンテンツはプレーンテキストとして扱われる。

コマンドライン命令やシェルスクリプトなど、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 はオプションのパラメータを受け付けます。