テキストのマークアップ
テキスト書式設定コマンドは、テキストがどのように表示されるかを指定します。
\a (パラメータマーカー)
\a コマンドは、次の単語が形式パラメータ名であることをQDocに伝えます。
形式パラメータがドキュメントに記載されていない場合やスペルが間違っている場合、警告が表示されます。そのため、関数をドキュメント化する際は、関数の説明文内で各形式パラメータを名前で明記し、その前に\a コマンドを記述する必要があります。そうすることで、パラメータ名はイタリック体で表示されます。
形式パラメータ名は中括弧で囲むこともできますが、必須ではありません。
\c (コードフォント)
\c コマンドは、変数名、ユーザー定義のクラス名、およびC++のキーワード（例：int やfor など）をコードフォントで表示するために使用されます。
このコマンドは、引数を等幅フォントで表示します。コードフォントで表示するテキストにスペースが含まれる場合は、テキスト全体を中括弧で囲んでください：
\c コマンドは、引数内に特殊文字\ を受け付けますが、これを通常の文字として表示します。したがって、ネストされたコマンドを使用したい場合は、代わりにteletype (\tt)コマンドを使用する必要があります。
\details (折りたたみ可能)
\details および\enddetails コマンドは、表示/非表示の状態を制御する <summary> を持つ、折りたたみ可能な <details> 要素を生成します。
HTML 出力を生成する際は、\details および\enddetails コマンドを使用して、折りたたみ可能な<details> HTML 要素を生成します。このコマンドには、中括弧で囲まれたオプションの要約文字列を指定できます。このオプション引数は、詳細部分の表示される見出しを指定します。
引数が省略された場合、QDocは要約文字列として「...」を出力します。
たとえば、次のような入力の場合：
/*!
\details {QDoc details}
\note You're looking at detailed information.
\enddetails
*/QDocがHTMLを生成する場合、これらのコマンドは次のように変換されます：
<details>
<summary>QDoc details</summary>
<div class="admonition note">
<p><b>Note: </b>You're looking at detailed information.</p>
</div>
</details>QDocはこれを次のようにレンダリングします：
QDocの詳細
注：現在 、詳細情報を表示しています 。
その他の出力形式の場合、QDocは要約文字列を無視し、内容を通常の段落として生成します。このコマンドはQt6.6でQDocに導入されました。
\div
\div および\enddiv コマンドは、特別な書式設定属性を適用すべき、大規模または小規模なテキストブロック（他のQDocコマンドを含む場合もあります）を区切ります。
引数は、以下に示す QDoc コメントのように、中括弧で囲んで指定する必要があります。この引数は解釈されることはありませんが、QDoc によって出力されるタグの属性として使用されます。
たとえば、インライン画像を、現在のテキストブロックの右側にフロート表示させたい場合などがあります：
/*!
\div {class="float-right"}
\inlineimage qml-column.png
\enddiv
*/QDocがHTMLを生成する場合、これらのコマンドは次のように変換されます:
<div class="float-right"><p><img src="images/qml-column.png" /></p></div>HTMLの場合、属性値「float-right」はstyle.cssファイル内の記述を参照することになります。この例では、次のような記述が該当します：
div.float-right
{
float: right; margin-left: 2em
}注： \div コマンドはネスト可能であることに注意してください。
以下に、Qt 4.7 の index.html を生成するために使用される index.qdoc ファイルからの例を示します：
\div {class="indexbox guide"}
\div {class="heading"}
Qt Developer Guide
\enddiv
\div {class="indexboxcont indexboxbar"}
\div {class="section indexIcon"} \emptyspan
\enddiv
\div {class="section"}
Qt is a cross-platform application and UI
framework. Using Qt, you can write web-enabled
applications once and deploy them across desktop,
mobile and embedded operating systems without
rewriting the source code.
\enddiv
\div {class="section sectionlist"}
\list
\li \l{Getting Started}
\li \l{Installation} {Installation}
\li \l{how-to-learn-qt.html} {How to learn Qt}
\li \l{tutorials.html} {Tutorials}
\li \l{Qt Examples} {Examples}
\li \l{qt4-7-intro.html} {What's new in Qt 4.7}
\endlist
\enddiv
\enddiv
\enddiv
Qt ドキュメントのレンダリングに使用される style.css ファイルにあるように、すべての class 属性の値が定義されている場合、上記の例は次のようにレンダリングされます：
Qt 開発者ガイド
関連項目 \span.
\span
\span コマンドは、小さなテキストブロックに特別な書式設定を適用します。
以下のQDocコメントに示すように、2つの引数を指定する必要があります。各引数は中括弧で囲む必要があります。最初の引数は解釈されませんが、QDocによって出力されるタグの書式設定属性を指定します。2番目の引数は、特別な書式設定属性でレンダリングされるテキストです。
たとえば、番号付きリストの各要素の最初の単語を青色で表示したい場合などがあります。
/*!
Global variables with complex types:
\list 1
\li \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
\li \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
\li \span {class="variableName"} {constComplex1} in globals.cpp at line 16
\li \span {class="variableName"} {constComplex2} in globals.cpp at line 17
\endlist
*/変数名`variableName`は、style.css 内の句を参照します。
.variableName
{
font-family: courier;
color: blue
}上記のvariableName句を使用すると、この例は次のようにレンダリングされます：
複雑な型を持つグローバル変数：
- globals.cpp の 14 行目にあるmutableComplex1
- globals.cpp の 15 行目にあるmutableComplex2
- globals.cpp の 16 行目にあるconstComplex1
- globals.cpp の 17 行目のconstComplex2
注： spanコマンドを使用しても 、新しい段落は開始されません。
関連項目 \div。
\tm (商標)
\tm コマンドは、その引数が商標であることを示します。QDocは、ページを生成する際に、引数の最初の出現箇所に商標記号 `™` を付加します。
プロジェクトの設定では、navigation.trademarkspage 変数を使用して、商標関連のドキュメントを含むページのタイトルを定義します。
navigation.trademarkspage = Trademarksこの変数が設定されている場合、商標記号が記述されている箇所はすべて、商標ページへのリンクとなります。
注： セクションのタイトル内では 、\tm コマンドは無視され、その引数はそのまま表示されます。
関連項目 \section1 および navigation。
\tt (テレタイプフォント)
\tt コマンドは、その引数を等幅フォントで表示します。このコマンドの動作は \c コマンドと全く同じように動作しますが、\tt では引数内にQDocコマンドをネストさせることができます（例： \e、 \b および \underlineなど）を引数内にネストして指定できる点が異なります。
/*!
After having populated the main container with
child widgets, \c setupUi() scans the main container's list of
slots for names with the form
\tt{on_\e{objectName}_\e{signalName}().}
*/コードフォントで表示するテキストにスペースが含まれる場合は、テキスト全体を中括弧で囲んでください。
関連項目 \c。
\b
\b コマンドは、その引数を太字で表示します。このコマンドは、以前は\bold と呼ばれていました。
/*!
This is regular text; \b {this text is
rendered using the \\b command}.
*/\br
\br コマンドは、強制改行を行います。
\e (強調、斜体)
\e コマンドは、その引数を特別なフォント（通常はイタリック体）で表示します。このコマンドは以前は\i と呼ばれていましたが、現在は非推奨となっています。
引数にスペースやその他の句読点が含まれる場合は、引数を中括弧で囲んでください。
/*!
Here, we render \e {a few words} in italics.
*/スペースを含む引数内で他の QDoc コマンドを使用する場合は、必ずその引数を中括弧で囲む必要があります。ただし、QDoc は丸括弧を自動的に認識するため、次のような場合には中括弧は必要ありません:
/*!
An argument can sometimes contain whitespaces,
for example: \e QPushButton(tr("A Brand New Button"))
*/最後に、末尾の句読点は引数に含まれません。また、「's」も同様です。
\sub
\sub コマンドは、引数を通常のテキストのベースラインより下に配置し、より小さいフォントで表示します。
/*!
Definition (Range): Consider the sequence
{x\sub n}\sub {n > 1} . The set
{x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}
is called the range of the sequence.
*/引数にスペースやその他の句読点が含まれる場合は、引数を中括弧で囲んでください。
\sup
\sup コマンドは、引数を通常のテキストのベースラインより上に配置し、より小さいフォントで表示します。
/*!
The series
1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
is called the \i {geometric series}.
*/引数にスペースやその他の句読点が含まれる場合は、引数を中括弧で囲んでください。
\uicontrol
\uicontrol コマンドは、コンテンツをUIコントロール要素として使用することを指定するために使用されます。HTMLを使用する場合、出力は太字で表示されます。
関連項目 \b.
\underline
\underline コマンドは、その引数を下線付きで表示します。
/*!
The \underline {F}ile menu gives the users the possibility
to edit an existing file, or save a new or modified
file, and exit the application.
*/引数にスペースやその他の句読点が含まれている場合は、引数を中括弧で囲んでください。
\\ (二重バックスラッシュ)
「\\」という文字列は、1つのバックスラッシュに展開されます。
QDoc コマンドは常に単一のバックスラッシュで始まります。テキスト中に単一のバックスラッシュを表示するには、2つのバックスラッシュを入力する必要があります。2つのバックスラッシュを表示したい場合は、4つ入力する必要があります。
/*!
The \\\\ command is useful if you want a
backslash to appear verbatim, for example,
writing C:\\windows\\home\\.
*/ただし、テキストを等幅フォントで表示したい場合は、 \c コマンドを使用できます。このコマンドは、バックスラッシュを他の文字と同様に認識して表示します。例：
/*!
The \\c command is useful if you want a
backslash to appear verbatim, and the word
that contains it written in a monospace font,
like this: \c {C:\windows\home\}.
*/-- (エンダッシュ)
QDocは二重ハイフンをエンダッシュとして表示します。\c コマンドなど、入力内容をそのまま表示するように設計されたQDocマークアップコマンドでは、二重ハイフンがエンダッシュ文字に置き換えられることはありません。例：
/*!
The \\c command -- useful if you want text in a monospace font --
is well documented.
*/ただし、QDocが期待どおりに出力をレンダリングするようにするため、他のコマンドではハイフンにエスケープ処理が必要になる場合があります。例えば：
/*!
This \l {endash-sequence}{link to the -- (endash) sequence}
isn't escaped and QDoc therefore renders an endash in the link
text. However, the escaped
\l {endash-sequence}{link to the \-- (endash) sequence}
renders both hyphens as intended.
*/警告： セクションやページの見出しにはエンダッシュを使用しないでください 。見出しにエンダッシュなどの特殊文字が含まれていると、見出しへのリンクが機能しなくなる可能性があります。
関連項目--- (エムダッシュ)。
---（エムダッシュ）
QDoc は、3 つのハイフンをエムダッシュとして表示します。入力内容をそのまま表示するように設計された QDoc マークアップコマンド（\c コマンドなど）は、3 つのハイフンをエムダッシュ文字に置き換えることはありません。例：
/*!
The \\c command---useful when you want text to be rendered
verbatim---is well documented.
*/ただし、QDocが期待どおりに出力をレンダリングするようにするには、他のコマンドではハイフンにエスケープ処理を施す必要がある場合があります。例えば：
/*!
This \l {emdash-sequence}{link to the --- (emdash) sequence}
isn't escaped and QDoc therefore renders an emdash in the link
text. However, the escaped
\l {emdash-sequence}{link to the -\-- (emdash) sequence}
renders both hyphens as intended.
*/注： この例でのエスケープされた制御シーケンスは 、エンダッシュ用です。これにより、出力でハイフンの直後にエンダッシュが続くことを防ぎます。
警告： セクションやページの見出しでは、エムダッシュの使用を避けてください 。見出しにエムダッシュなどの特殊文字が含まれていると、見出しへのリンクが機能しなくなる可能性があります。
関連項目-- (エンダッシュ)。
© 2026 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.
