【Java】コメントの種類と書き方

新人研修のソースレビューで毎回指摘してるので、新人さん向けに整理してみました

Javaのコメントの種類

• １行コメント
• 複数行コメント
• JavaDoc

１行コメントの書き方

// コメント

eclipseだとctrl + /で入れたり消したりできる。

複数行コメントの書き方

/*
* 先頭のアスタリスクは１つ
* comment
*/

JavaDoc

/**
 * クラスやメソッドの説明
 * 先頭はアスタリスク２つです。
 */

前述した２つとは性質の違う特別なコメント。
JavaDocコメントはjavaのコマンドを使ってドキュメント化できる=リファレンスマニュアルになる。
そのため、いろんなタグが使える。
マニュアルなので、ソースコード内でちょっとした説明を書くときには使ってはいけない。

タグの例

タグ	説明
@param	パラメータ（引数）についての説明。
@return	戻り値についての説明。
@author	プログラムの作成者についての説明。
@throw	投げられる例外についての説明。