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

@author【開発者・著者】
@authors【開発者・著者】

メモ

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

構文

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

@author と @authors は別段落

例

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

【HTML出力例】

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

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

【HTML出力例：ライトモード】

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

【HTML出力例：ダークモード】

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