今日の技術

javadoc のコメント記述方法についてご紹介します。
Java で関数を作成したときに、一定の法則で定義したコメントを一緒に記述しておくと、
この関数についての簡易的なヘルプを参照することができるようになります。
コードの再利用性を考えると、ぜひ作成しておきたいものです。

やり方ですが、以下のコメントを入れます。
/**
* 関数の定義です。

* ２行目です。
*/
コメント開始を「/**」にするだけです。

コメント中では、以下の主な記述が使用できます。
・@param 引数の解説
・@return 戻り値の解説

なお、これは、変数定義にも使用できます。

/** ダミー値(初期値は -1) */
private int dummy = -1;