* * *
* *"> *
* * *
Akihito Nagata's Page
|
|
Javadoc のメモcoffee
タグは説明の後に書くべし。

概要のドキュメンテーションタグ

overview.html というファイルに書く。
@see関連項目
@since導入されたバージョン
@author
@version
{@link}インラインリンクを挿入
{@linkplain}インラインリンクを挿入
{@docRoot}生成されるページから見た、生成ドキュメントの (生成先の) ルートディレクトリへの相対パス

パッケージドキュメンテーションタグ

package.htmlという名前のファイルに書く。
@see 関連項目
@since導入されたバージョン
@deprecated 使用するべきではないことを示す
@serial
@author 著者
@version バージョン
{@link} インラインリンクを挿入
{@linkplain} インラインリンクを挿入
{@docRoot}生成されるページから見た、生成ドキュメントの (生成先の) ルートディレクトリへの相対パス

クラスおよびインタフェースドキュメンテーションタグ

クラスの宣言の直前に書く。
@see 関連項目
@since 導入されたバージョン
@deprecated使用するべきではないことを示す
@serial
@author 著者
@version バージョン
{@link} インラインリンクを挿入
{@linkplain}インラインリンクを挿入
{@docRoot} 生成されるページから見た、生成ドキュメントの (生成先の) ルートディレクトリへの相対パス

フィールドドキュメンテーションタグ

フィールド定義の直前に書く。
@see 関連項目
@since導入されたバージョン
@deprecated 使用するべきではないことを示す
@serial直列化可能
@serialField
{@link} インラインリンクを挿入
{@linkplain} インラインリンクを挿入
{@docRoot}
{@value}

コンストラクタおよびメソッドドキュメンテーションタグ

メソッド定義の直前に書く。
@see 関連項目
@since導入されたバージョン
@deprecated 使用するべきではないことを示す
@paramパラメータ
@return 戻り値
@throws (@exception) 例外
@serialData
{@link} インラインリンクを挿入
{@linkplain} インラインリンクを挿入
{@inheritDoc} コメントの継承
{@docRoot}生成されるページから見た、生成ドキュメントの (生成先の) ルートディレクトリへの相対パス
|
前のページはこちら