[Javadoc] メソッドに対するコメントの基本

メソッドに対するコメントは、以下４つの内容から構成されます。

• 主説明
• 引数の説明
• 返却値の説明
• 例外の説明

・主説明

メソッドの仕様を文章として記述するものです。

・引数の説明

メソッドが受け取る引数それぞれについて、メソッドを呼び出す側が意識すべき制約を記述するものです。

使用するブロックタグ：@param

・返却値の説明

メソッドが返す値について説明するものです。

使用するブロックタグ：@return

・例外の説明

メソッドが発生させる可能性がある例外について説明するものです。

検査例外については記述が必須ですが、非検査例外（実行時例外：RuntimeExceptionなど）は省略可能です。

使用するブロックタグ：@throws

以上から、メソッドコメントはこのような形になります。

/**

 * （主説明）

 *

 * @param 引数名 説明

 * @return 戻り値の説明

 * @throws 例外名 例外の説明

 */