JavaDocのタグ(主に関数)

コメントヘッダに書くタグのうち、よく使うものについて説明する。
※C++対象

タグ一覧

大体関数ヘッダにつけるもの

タグ 説明対象 備考
@brief 概要
@param[in] 引数(入力)
@param[out] 引数(出力) ポインタなら「nullを渡してはいけない」とか書いておく
@param[in,out] 引数(入出力)
@return 戻り値 1関数に対して1つだけ
@retval 戻り値 複数列挙できる
@throw エラー値とエラーになる条件 エラーの意味だけ書いても意味がない
@attention この関数を呼び出す上での注意事項
@note 覚え書き 実装メモとか?
@pre 事前条件
@pose 事後条件

@retval の使用例

/**  
 * @brief 関数の概要  
 *   
 * @retval true (trueを返す条件を書く)  
 * @retval false (falseを返す条件を書く)  
 */  
bool is_start();  

Doxygen Previewer

VSCodeで今開いているファイルのDoxygenを確認できる

参考