@brief・@short【概要】
@details【詳細】
@note【メモ・覚え書き】
@remark・@remarks【備考・注釈】
@brief【概要】
@short【概要】
メモ
- 概要を記述
- 複数指定可
- 空行・他のセクションコマンドで終了
- 各種一覧・詳細ページの先頭で使用
- 先頭行に記述する場合、指定でコマンドは省略可
(関連:JAVADOC_AUTOBRIEF ・QT_AUTOBRIEF ・MULTILINE_CPP_IS_BRIEF) - デフォルトで詳細にも出力
(関連:REPEAT_BRIEF)
- 関連
- 外部リンク
構文
@brief 概要
@short 概要
例
/// @brief 概要
/// @details 詳細
class ClassBrief { };
@details【詳細】
メモ
- 詳細を記述
- 複数指定可
- 先頭行に記述する場合、デフォルトでコマンドは省略可
(関連:JAVADOC_AUTOBRIEF ・QT_AUTOBRIEF ・MULTILINE_CPP_IS_BRIEF)
- 関連
構文
@details 詳細
例
/// 詳細 (省略形)
/// @brief 概要
class ClassDetailsA { };
/// @brief 概要
/// @details 詳細
class ClassDetailsB { };
@note【メモ・覚え書き】
メモ
- メモ・覚え書きを記述
- 隣接する複数の @note【メモ・覚え書き】コマンドは1つの段落に結合
- 空行・他のセクションコマンドで終了
- マークダウン (Markdown) の [!NOTE]【アラート:メモ】 は、このコマンドに変換 1.11.0
- 関連
- 外部リンク
構文
@note メモ
例
/// @note メモA
/// @note メモB
/// @note メモC1
/// メモC2
/// メモC3
【HTML出力例:ライトモード】
- 覚え書き
- メモA
- メモB
- メモC1 メモC2 メモC3
- メモB
【HTML出力例:ダークモード】
- 覚え書き
- メモA
- メモB
- メモC1 メモC2 メモC3
- メモB
【マークダウン:アラート】
/// > [!NOTE]
/// > メモD
///
/// > [!NOTE]
/// > メモE
///
/// > [!NOTE]
/// > メモF1
/// > メモF2
【HTML出力例】
- 覚え書き
- メモD
- メモE
- メモF1 メモF2
- メモE
@remark【備考・注釈】
@remarks【備考・注釈】
メモ
- 備考・注釈を記述
- 隣接する複数の @remark【備考・注釈】・@remarks【備考・注釈】コマンドは1つの段落に結合
- 空行・他のセクションコマンドで終了
- マークダウン (Markdown) の [!TIP]【アラート:ヒント】 は、このコマンドに変換 1.11.0
- 関連
- 外部リンク
構文
@remark 備考
@remarks 備考
@remark と @remarks は同一段落
例
/// @remark 備考A
/// @remark 備考B
/// @remark 備考C1
/// 備考C2
/// 備考C3
【HTML出力例:ライトモード】
- 注釈
- 備考A
- 備考B
- 備考C1 備考C2 備考C3
- 備考B
【HTML出力例:ダークモード】
- 注釈
- 備考A
- 備考B
- 備考C1 備考C2 備考C3
- 備考B
【マークダウン:アラート】
/// > [!TIP]
/// > 備考D
///
/// > [!TIP]
/// > 備考E
///
/// > [!TIP]
/// > 備考F1
/// > 備考F2
【HTML出力例】
- 注釈
- 備考D
- 備考E
- 備考F1 備考F2
- 備考E