@author・@authors【開発者】
@copyright【著作権情報】
@date【日付情報】
@since【有効バージョン】
@version【バージョン】
@pre【事前条件】・@post【事後条件】・@invariant【不変条件】

@author・@authors【開発者】

メモ

  • 開発者を記述 (書式はフリー)
    • 隣接する複数の @author・@authors【開発者】コマンドは1つの段落に結合
    • 空行・他のセクションコマンドで終了
  • 関連

構文

@author  開発者名 (複数指定可)
@authors 開発者名 (複数指定可)

@author@authors は別段落

/// @author 開発者A
/// @author 開発者B
/// @author 開発者C1
///         開発者C2
///         開発者C3

【HTML出力例】

著者
開発者A
開発者B
開発者C1 開発者C2 開発者C3

@copyright【著作権情報】

メモ

構文

@copyright 著作権情報の説明

/// @copyright 著作権情報

【HTML出力例】


@date【日付情報】

メモ

  • 日付情報を記述 (書式はフリー)
    • 隣接する複数の @date【日付情報】コマンドは1つの段落に結合
    • 空行・他のセクションコマンドで終了
  • 関連

構文

@date 日付情報 (複数指定可)

/// @date 2001/2/3
/// @date 2002-2003
/// @date 2014,
///       2016,
///       2018

【HTML出力例】

日付
2001/2/3
2002-2003
2014, 2016, 2018

@since【有効バージョン】

メモ

構文

@since 有効バージョン

/// @since 1.2.3

【HTML出力例】

から
1.2.3

@version【バージョン】

メモ

構文

@version バージョン文字列 (複数指定可)

/// @version 4.5.6
/// @version 4.6.0
/// @version 5.6.7
///          5.7.0
///          5.8.0

【HTML出力例】

バージョン
4.5.6
4.6.0
5.6.7 5.7.0 5.8.0

@pre【事前条件】・@post【事後条件】・@invariant【不変条件】

メモ

構文

@pre 事前条件の説明
@post 事後条件の説明
@invariant 不変条件の説明

/// @pre 事前条件A
/// @pre 事前条件B
/// @pre 事前条件C1
///      事前条件C2
///      事前条件C3
/// @post 事後条件A
/// @post 事後条件B
/// @post 事後条件C1
///       事後条件C2
///       事後条件C3
/// @invariant 不変条件A
/// @invariant 不変条件B
/// @invariant 不変条件C1
///            不変条件C2
///            不変条件C3

【HTML出力例】

事前条件
事前条件A
事前条件B
事前条件C1 事前条件C2 事前条件C3
事後条件
事後条件A
事後条件B
事後条件C1 事後条件C2 事後条件C3
不変
不変条件A
不変条件B
不変条件C1 不変条件C2 不変条件C3