コードのインライン挿入

以下のコマンドは、書式設定なしでソースコードを表示するために使用されます。ソースコードは新しい行から始まり、コードとして表示されます。

\code

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

コマンドラインの指示、シェルスクリプト、または QDoc が認識する Qt 言語以外で記述されたコンテンツをドキュメント化する場合は、代わりに \badcode を使用してください。

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

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

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

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

ハイライトと自動リンク

\code コマンドは、言語設定変数で定義されている特定の言語のコードとして、その内容を解析しようとします。これにより、コード内で検出された型に対する色付けや自動リンクが提供されます。

QDoc バージョン 6.4 以降、例外として、QML 専用のトピック内で`\code ` コマンドが使用された場合、QDoc はまずそのコードを QML として認識しようとします。その他のトピックについては、言語設定変数が優先されます。コードスニペットを明示的に 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がマークアップできない言語を引用する場合に役立ちます。

あるいは、QDocが認識しないコードブロックに対して、`codelanguages` 設定変数に保持されているリストにその言語を追加することで、言語を指定することもできます。これにより、生成されたHTMLにメタデータが含まれるようになり、他のツールがコードの構文強調表示を行う際に利用できるようになります。

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

QDoc バージョン 5.12 以降、\code コマンドはオプションのパラメータも受け付けるようになりました。パラメータは、コードスニペットに単純な文字列を挿入するのに役立ちます。スニペット内の特定の位置に文字列を挿入するには、バックスラッシュの後に数字 (1～8) を指定します。 この数字は引数リストの順序に対応しており、引数はスペースで区切られ、任意の言語引数の後に続きます。

例：

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

上記のスニペットの場合、QDocは「hello」という単語をCスタイルのコメントで囲んで表示します。

外部ファイルからのコードの組み込み

外部ファイルからコードスニペットをインクルードするには、 \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 もオプションのパラメータを受け付けます。