@author・@authors【開発者】
@copyright【著作権情報】
@date【日付情報】
@showdate【日時 (インライン)】1.9.5
@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 日付情報 (複数指定可)

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

【HTML出力例】

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

@showdate【日時 (インライン)】1.9.5

メモ

構文

@showdate "書式" [日時]

書式指定可能な書式指定子は下記参照
日時以下の形式
    省略:現在日時
    日付のみ:西暦年 (4桁)-月 (1~2桁)-日 (1~2桁)
    日時 (秒なし):西暦年 (4桁)-月 (1~2桁)-日 (1~2桁)時 (1~2桁):分 (1~2桁)
    日時 (秒あり):西暦年 (4桁)-月 (1~2桁)-日 (1~2桁)時 (1~2桁):分 (1~2桁):秒 (1~2桁)
書式指定子備考
%y西暦年下2桁
%Y西暦年
%m月 (2桁)
%-m
%b月の省略名 (ロケール対応)
%B月の名称 (ロケール対応)
%d日 (2桁)
%-d
%u曜日のインデックス (1:月曜 ~ 7:日曜)
%w曜日のインデックス (0:日曜 ~ 6:土曜)
%a曜日の省略名 (ロケール対応)
%A曜日の名称 (ロケール対応)
%H時 (24時間 2桁)
%-H時 (24時間)
%I時 (12時間 2桁)
%-I時 (12時間)
%M分 (2桁)
%-M
%S秒 (2桁)
%-S
%p午前/午後 (ロケール対応)
%%%

/// 【省略】@n
/// 現在日時:@showdate "%Y-%m-%d %H:%M:%S" @n
/// 【日付のみ】@n
/// @showdate "%y-%m-%d %a (%b %u)" 2012-3-4@n
/// @showdate "%Y-%-m-%-d %A (%B %w)" 2012-03-04@n
/// 【日時 (秒なし)】@n
/// @showdate "%Y-%m-%d %H:%M" 2001-2-3 4:5@n
/// @showdate "%Y-%-m-%-d %-H:%-M" 2001-2-3 4:5@n
/// 【日時 (秒あり)】@n
/// @showdate "%Y-%m-%d %H:%M:%S" 2001-2-3 4:5:6@n
/// @showdate "%Y-%-m-%-d %-H:%-M:%-S" 2001-2-3 4:5:6@n
/// @showdate "%Y-%m-%d %p %I:%M:%S" 2005-6-7 2:3:4@n
/// @showdate "%Y-%-m-%-d %p %-I:%-M:%-S" 2005-6-7 20:3:4

【HTML出力例】

【省略】
現在日時:YYYY-mm-dd HH:MM:SS
【日付のみ】
12-03-04 日 (3 7)
2012-3-4 日曜日 (3月 0)
【日時 (秒なし)】
2001-02-03 04:05
2001-2-3 4:5
【日時 (秒あり)】
2001-02-03 04:05:06
2001-2-3 4:5:6
2005-06-07 午前 02:03:04
2005-6-7 午後 8:3:4


@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