* 対象のメソッド・クラスのまで「/**」を記述し、Enterキー押下
* [project]-[Generate javadoc...] を選択
@version バージョン情報
@param 引数名/説明
@return 戻り値/説明
@see 関連項目(ex. クラス名/URL)
@since どのバージョンから存在しているか
@deprecated 非推奨であるか
<a> <img>
<p> <br>
<ul> <ol> <li>
<b> <i>
<table> <tr> <th> <td>
package-info.java (from Java 1.5)
* パッケージの説明を書くには、package-info.javaを作成する
サンプル
/**
*
* ここにパッケージの説明文を書く
*/
package com.sample;
Eclipseで「package-info.java」を追加するには
* package を追加時に、「package-info.java」を追加するチェックボックスにチェックを付けて追加。
その他コメント
TODOコメント
* 仕様が決まらないなどでコメントにその旨を記述しておく時は「// TODO : ～」で記述しておくといい
FIXMEコメント
* コードが間違っていて修正が必要な場合は「// FIXME : ～」で記述しておくといい
XXXコメント
* コードが正しくないが多くの場合動いてしまう時は「// XXX : ～」で記述しておくといい
理由
* Eclipseを使っている場合、Tasksビューでコメントを管理することができるため
* Jenkinsを使っている場合、Task Scanner Pluginを入れれば、未解決タスクが管理できるため
参考文献
http://d.hatena.ne.jp/monry84/20080120/1201233841
