関数コメントに記載する内容

Posted: 2019年02月06日

Javadocなど関数コメントが設計となる場合には、
次の内容を記載する。

  1. 関数仕様
  2. 引数説明 (データの説明、許容範囲)
  3. 戻り値説明 (データの説明、許容範囲)
  4. 例外処理

関数仕様

関数が何をするかを記載する

指定された年月日の範囲を指定された日付分加算します。
演算結果を返却します。
引数が異常な場合は、例外を発生させます。

引数説明

引数一つ一つに対して説明を記載する

その変数にはどのようなデータが入っているべきかを記載する。

@param month 処理対象の月

その変数に入っているべき値の範囲を記載する。

@param month 処理対象の月 (1-12)

戻り値説明

どのような値が返却されるのかを記載する
関数の処理結果であれば、そのことがわかるようにする。

@return 判定結果 判定で正常な場合はtrue、異常な場合は、false

エラー処理

引数の許容範囲内外の場合
それ以外の前提となる条件を満たしてない場合など
発生条件とエラー処理について記載する
 (エラー処理が、例外をthrowしない場合でもそのことを記載する)

カテゴリー: Tips | コメント無し »