1. ホーム
  2. java

[解決済み] package-info.javaとは何ですか、またどのように私のプロジェクトに追加するのですか?

2022-02-18 03:50:57

質問内容

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

- Missing package-info.java file.

  1. とは package-info.java また、どのように役立つのでしょうか?
  2. このメッセージにどう対処すればよいですか?

解決方法は?

javadocの説明を格納するために使用されます。以下の場所で見つけることができます。 7.4.1. 名前付きパッケージ Java®言語仕様 :

を推奨しています。 package-info.java がある場合は、その代わりに package.html javadoc や他の類似のドキュメント生成システムで使用されます。このファイルが存在する場合、ドキュメント生成ツールは、(おそらく注釈付きの) パッケージ宣言の直前にあるパッケージドキュメントのコメントを package-info.java . このように package-info.java は、パッケージレベルの注釈とドキュメントのための唯一のリポジトリになります。将来、他のパッケージレベルの情報を追加することが望ましい場合、このファイルはその情報のための便利なホームであることが証明されるはずです。

一例です。

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

この回答もご覧ください

アップデイト ここから

package-info.java のパッケージへの追加を支援します。

<ブロッククオート

package-info.java ファイルは手作業でパッケージに追加できますが (Java クラスを手作業で作成するのと同じように)、IDE では、新しいパッケージを作成するたびに package-info.java ファイルを含めるオプションが提供されていることがよくあります。 下図に示すEclipseでは、New Java Package作成ウィザードにシンプルな(そして見落とされがちな)チェックボックスが用意されています。