web-dev-qa-db-ja.com

package-info.Javaとは何ですか？プロジェクトに追加するにはどうすればよいですか？

SpringプロジェクトでCheckstyleを実行すると、次のように表示されます。

- Missing package-info.Java file.
  1. package-info.Javaとは何ですか？
  2. このメッセージにどのように対処できますか？
javaspringhibernatespring-mvccheckstyle
21
yb3prod

Javadocの説明を保存するために使用されます。 7.4.1。Named Packages の TheJava®Language Specification にあります：

package-info.Javaが存在する場合は、javadocおよび他の同様のドキュメント生成システムのpackage.htmlの代わりにすることをお勧めします。このファイルが存在する場合、ドキュメント生成ツールは、package-info.Javaの（おそらく注釈付きの）パッケージ宣言の直前のパッケージドキュメントコメントを検索する必要があります。このようにして、package-info.Javaがパッケージレベルの注釈とドキュメントの唯一のリポジトリになります。将来、他のパッケージレベルの情報を追加することが望ましくなった場合、このファイルはこの情報の便利なホームとなるはずです。

例：

/**
 * Info about this package doing something for package-info.Java file.
 */
package your.project.doSomething;

この回答も確認してください

[〜＃〜] update [〜＃〜]ここから

Package-info.Javaをパッケージに追加するのに役立ちます

Package-info.Javaファイルは手動でパッケージに追加できますが（Javaクラスを手動で作成できるように）、IDEにはpackage-infoを含めるオプションがよくあります。新しいパッケージを作成するたびにJavaファイルを作成するEclipse（以下に示す）では、新規Javaパッケージ作成ウィザード）に単純な（そして見過ごされがちな）チェックボックスがあります。

enter image description here

27
Jordi Castilla