Javadocのタグ

ウィキペディア小見出し辞書

Javadocのタグ

出典: フリー百科事典『ウィキペディア（Wikipedia）』 (2020/04/19 04:36 UTC 版)

「Javadoc」の記事における「Javadocのタグ」の解説

開発者はソースコードにコメントを記述する時に、ある程度の決まった形式の文章とJavadocタグを使用する。ソースのコメントの内、/**で始まるものが、生成されたHTMLに含まれることになる。Javadocタグは、頭に"@" 記号が付く。いくつかのタグはテーブル用のものである。 タグ記述内容@author 開発者名を記述する。 @deprecated 廃止されたクラス やメソッドに付けられる。コンパイル時にこれがつけられたメソッドを使用すると警告を発する。IDEによっては、このマークがつけられたメソッドを使用したコーディングをした場合、警告を発する。Java SE 5以降からは、@Deprecatedアノテーションを用いて同様のことができるようになっている。 @exception メソッドが投げる例外クラスとその説明を記述する。— @throwsも参照。 @param メソッドの引数や総称型のパラメータを記述する。引数の数だけ記述する必要がある。引数名と引数の概要を記述する。 @return メソッドの戻り値を記述する。戻り値がvoidの時は記述しなくて良い。 @returns @returnと同じ。 @see 関連する他のメソッドまたはクラスを記述する。このタグの内容は自力で記述するのは大変なのでIDEなどで自動生成すると良い。 @since クラスまたはメソッドの導入されたバージョンを記述する。IDEなどの自動生成ツールでここに日付やバージョン番号などの情報をわりあてることができる。 @throws メソッドが投げる例外を記述する。@exceptionと同義。Javadoc 1.2で追加された。 @version クラスまたはメソッドのバージョンを記述する。バージョン管理システムを用いてこのバージョン番号割り当てを自動化することができる。 {@link} 標準テキストのラベルとインラインリンクを挿入する。{パッケージ名.クラス名#メソッド名 label}という方式で記述。labelの文法は@seeと同じ。 {@docRoot} 生成されたドキュメントのルートディレクトリを基点とする相対パスを表す。 @serial デフォルトで直列化可能フィールドのdocコメントで使用する。このタグの後に説明を入れる。これは直列化形式ページの生成に使われる。 @serialField SerializableクラスのObjectStreamField コンポーネントをドキュメント化する。各 ObjectStreamField コンポーネントに対して @serialField タグを 1 つ使う必要がある。このタグの後に、順番にフィールド名、フィールドの型、フィールドの説明を記述する。 @serialData データの型と順序を直列化形式でドキュメント化。このデータには、特に writeObject メソッドによって書き込まれる任意指定のデータ、および Externalizable#writeExternal(ObjectOutput) メソッドによって書き込まれるすべてのデータが含まれる。@serialData タグは、writeObject(Object)、readObject()、writeExternal(ObjectOutput)、および readExternal(ObjectInput)の各メソッドの doc コメントで使用できる。 このタグの後に説明を記述する。