パッケージコメントファイル
出典: フリー百科事典『ウィキペディア（Wikipedia）』 (2020/04/19 04:36 UTC 版)
「Javadoc」の記事における「パッケージコメントファイル」の解説
package-info.javaというファイルにコメントを記述する。JDK 1.4 までは package.html に記載した。これは以下のように、クラスやメソッドなどに記述するJavadocコメントと同じ要領で済む。ただし、packageキーワードを用いてパッケージ宣言しなければならない。 /** * ここにパッケージの概要を記述する。 * @since 1.5 */package com.example.wikipedia; この記法は、Java SE 5から登場したアノテーションには、パッケージにも指定できるものがあるために用意された。これにより、package-info.javaにはアノテーションも保存でき、たとえばパッケージに対して@Deprecatedアノテーションを指定できるようになった。package.htmlではアノテーションが使用できないため、package-info.javaの使用はpackage.htmlよりも推奨されている。
※この「パッケージコメントファイル」の解説は、「Javadoc」の解説の一部です。
「パッケージコメントファイル」を含む「Javadoc」の記事については、「Javadoc」の概要を参照ください。
ウィキペディア小見出し辞書の「パッケージコメントファイル」の項目はプログラムで機械的に意味や本文を生成しているため、不適切な項目が含まれていることもあります。ご了承くださいませ。
お問い合わせ。
- パッケージコメントファイルのページへのリンク
