@brief・@short【概要】
@details【詳細】
@note【メモ】
@remark・@remarks【備考】

@brief【概要】・@short【概要】

メモ

構文

@brief 概要
@short 概要

/// @brief 概要
/// @details 詳細
class ClassBrief { };

@details【詳細】

メモ

構文

@details 詳細

/// 詳細 (省略形)
/// @brief 概要
class ClassDetailsA { };

/// @brief 概要
/// @details 詳細
class ClassDetailsB { };

@note【メモ】

メモ

  • メモを記述
    • 隣接する複数の @note【メモ】コマンドは1つの段落に結合
    • 空行・他のセクションコマンドで終了
  • 関連

構文

@note メモ

/// @note メモA
/// @note メモB
/// @note メモC1
///       メモC2
///       メモC3

【HTML出力例】

覚え書き
メモA
メモB
メモC1 メモC2 メモC3

@remark【備考】・@remarks【備考】

メモ

構文

@remark  備考
@remarks 備考

@remark@remarks は同一段落

/// @remark 備考A
/// @remark 備考B
/// @remark 備考C1
///         備考C2
///         備考C3

【HTML出力例】

注釈
備考A
備考B
備考C1 備考C2 備考C3