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

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

注意: これらのコマンドのほとんどは C++ コードをレンダリングするためのもので すが、他のコマンドよりも、˶snippet コマンドと˶scodelineコマンドの方が推奨されま す。これらのコマンドを使用すると、他のQt言語バインディング用の同等のコード・スニペットを、ドキュメンテーションのC++スニペットに置き換えることができます。

\コード

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

注意: 文章の中の短いコード断片には、♪♪codeコマンドを使うことができます。endcodeコマンドは、ソースコードのスニペットを囲みます。このコマンドは、html <pre>要素内の別の段落にコードをそのままレンダリングし、囲んだスニペットを解析して、コード内の既知の型へのリンクを作成します。

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

QDocは、"verbatim code blocks within a/*! ...*/ comment "内の逐語的なコードブロックに共通なインデントをすべて削除してから、標準的なインデントを追加します。

注意: このコマンドは、"quotefromfile "または "quotefile "コマンドを使用して外部か ら引用されたコードには適用されません。

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

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

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

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

を受け付け、他のコードと同じようにレンダリングされます。これにより、コード内で検出された型のハイライトと自動リンクが提供されます。

QDoc バージョン 6.4 以降の例外として、QML 固有のトピック内で ¦code コマンドが使用されると、QDoc は最初にコードを QML として認識しようとします。他のトピックでは、言語設定変数が優先されます。コード・スニペットを明示的に QML としてマークするには、代わりに ˶´﹀`˵コマンドを使用してください。

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

QDocのバージョン5.12以降、"code "コマンドはオプションのパラメータも受け付けます。パラメータは、コード・スニペットに単純な文字列を注入するのに便利です。スニペット内の特定の場所に文字列を注入するには、バックスラッシュの後に数字(1..8)を追加します。数字は引数リストの順番に対応し、引数はスペースで区切られます。

例えば

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

上のスニペットでは、QDocはhelloという単語をCスタイルのコメントで囲んで表示する。

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

外部ファイルからコード・スニペットをインクルードするためには、˶snippetコマンドと˶codelineコマンドを使用します。

( )このコマンドは、"Snippet "コマンドと "Codeline "コマンドを使用して、外部ファ イルのコードスニペットをインクルードします。

\バッドコード

冗長化されたコンテンツを別の段落に囲みますが、解析や自動リンク作成は行われません。代わりに、コンテンツはプレーンテキストとして扱われます。

コマンドライン命令やシェルスクリプトなど、Qt言語ではないコンテンツを文書化する場 合に、このコマンドで代用してください。

を使用する場合は、このコマンドで代用できます。

\¦qml

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

.qmlファイルのように完全でなければなりません。

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.