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

@author・@authors【開発者】

メモ

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

構文

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

@author と @authors は別段落

例

/// @author 開発者Ａ
/// @author 開発者Ｂ
/// @author 開発者Ｃ１
///         開発者Ｃ２
///         開発者Ｃ３

【HTML出力例】

著者
開発者Ａ
開発者Ｂ
開発者Ｃ１ 開発者Ｃ２ 開発者Ｃ３

@copyright【著作権情報】

メモ

構文

@copyright 著作権情報の説明

例

/// @copyright 著作権情報

【HTML出力例】

著作権所有
著作権情報

@date【日付情報】

メモ

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

構文

@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 事前条件Ａ
/// @pre 事前条件Ｂ
/// @pre 事前条件Ｃ１
///      事前条件Ｃ２
///      事前条件Ｃ３
/// @post 事後条件Ａ
/// @post 事後条件Ｂ
/// @post 事後条件Ｃ１
///       事後条件Ｃ２
///       事後条件Ｃ３
/// @invariant 不変条件Ａ
/// @invariant 不変条件Ｂ
/// @invariant 不変条件Ｃ１
///            不変条件Ｃ２
///            不変条件Ｃ３

【HTML出力例】

事前条件
事前条件Ａ
事前条件Ｂ
事前条件Ｃ１ 事前条件Ｃ２ 事前条件Ｃ３
事後条件
事後条件Ａ
事後条件Ｂ
事後条件Ｃ１ 事後条件Ｃ２ 事後条件Ｃ３
不変
不変条件Ａ
不変条件Ｂ
不変条件Ｃ１ 不変条件Ｃ２ 不変条件Ｃ３