JavaDocちょっと復習

java

ドキュメンテーションコメントはあまり意識してキチンと書いてなかったので反省して以下で復習。
http://www.javadrive.jp/javadoc/

注意点

ドキュメントの作成

javadoc -d doc Sample.java

dオプションは出力ディレクトリ指定

タグ

@author

クラス等の作者名(-authorオプション付けないとドキュメントに含まれない。)

@version

バージョン(-versionオプション付けないとドキュメントに含まれない。)

@see

別メソッド等への参照を関連項目として出力(単なる文字列や外部リンクも可)
パッケージ名が省略されている場合、パッケージ的に近いクラスから検索される。

/**
 * クラス
 * @see Class01
 * @see package.Class02
 */

/**
 * メソッド
 * @see #method01()
 * @see Class01#method02()
 * @see package.Class02#method3(int, int)
 * @see package.Class03#method4(int type, String text)
 */

/**
 * 説明文
 * @see "hoge"
 * @see <a href="http://www.google.co.jp/">外部リンク</a>
 */
@deprecated

非推奨を表す。

/**
 *  説明文
 *  @deprecated 注釈(非推奨になった理由等) {@link 代替メソッドorクラス}
 */
@since

導入されたバージョンを記入(@versionと対応)

@param

引数詳細

@return

戻り値詳細

@throws(@exception)

発生する可能性のある例外詳細

{@link}

@seeと同じ(@seeはブロックタグでこちらはインラインタグ)

/**
 * 説明文
 * 仔細は{@link #method(String)}を参照
 */
{@linkplain}

{@link}と同じ(こちらはフォントがプレーンテキストで表示される)