プロダクト/関連文書/JavaDocコメントの記述
概要
JavaDoc コメントの記述方法を示します。
共通のコメント
全てのコメントは HTML タグを使用して記述します。
段落 (<p>)
段落は <p> タグで囲みます。
<p> ほげほげの検索を行う DAO です。 </p>
リスト (<ul>, <ol>, <li>)
リストは <ul> <ol> <li> タグを使用します。
<p> 以下が具体的な機能です。 </p> <ul> <li>プロジェクトを混乱に落とす。 <li>プロジェクトメンバーの士気を下げる。 <li>プロジェクトを崩壊させる。 <li>賠償金を請求される。 </ul>
他のクラスを参照 {@link}
コメント中に他のクラスの名前を記述する場合、 {@link} タグを使用します。クラスが存在すれば、そのクラスの JavaDoc へのリンクを自動的に生成します。クラスが存在しなければ JavaDoc コマンドで警告が出力されますので、記述ミスに気づきやすく、便利です。
必須のタグ
Checkstyle により警告される全てのタグは必須であり、記述しなければなりません。
クラス コメント
製作者 (@author)
@author タグを記述します。必須とします。
@author $AUTHOR$
バージョン (@version)
@version タグを記述します。必須とします。
@version $Rev$, $Date$
メソッド コメント
引数 (@param) 、返り値 (@return)
必須とします。
例外 (@throws)
チェック例外は @throws タグの記述を必須とします。非チェック例外も、分かる範囲で @throws タグの記述を必要とします。
2005年11月04日(金) 04:19:43 Modified by uguuxp