Eclipse Juno - package-info.javaの使い方は？

Question

Eclipse Junoで新しいパッケージが作成されると、Javaファイル（package-info.java）が自動的に作成されます。そのファイルの使用は何ですか？別のクラスの特定のクラスをインポートするのに便利ですか？

Answer 1

package-info.javaは、package comment fileです。これは、パッケージに独自のドキュメントを提供するためにJavadocが使用します。

introduced in Javadoc 5.0であり、package.htmlの代わりになりました。

Answer 2

package-info.javaファイルには、パッケージレベルのドキュメントとannotationsが含まれています。

Answer 3

パッケージレベルの文書化に使用できます。たとえば、Springチームは、Spring Frameworkのコアでこれを非常に幅広く使用しています。

それに加えて、パッケージ内のすべてのクラスに適用されるアノテーションを含めることができます。たとえば、各クラスのEclipse Null分析のための注釈を書くことを避ける便利な方法です。

注釈をパッケージに適用するには、package-info.javaという名前のファイルが使用されます。