什么是 package-info.java，如何将它添加到我的项目中？

Question

当我在我的 Spring 项目上运行 Checkstyle 时，它​​会显示：

- Missing package-info.java file.

1. 什么是package-info.java，它有什么用处？
2. 我该如何处理这条消息？

Answer 1

用于存储javadoc描述。您可以在7.4.1. Named Packages 的The Java® 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;

Also check this answer

更新 from here

帮助将 package-info.java 添加到您的包中

虽然您可以手动将 package-info.java 文件添加到包中（就像您可以手动创建 Java 类一样），但 IDE 通常会为您提供在每次创建时包含 package-info.java 文件的选项一个新包。如下所示的 Eclipse 在 New Java Package 创建向导中提供了一个简单（但经常被忽视）的复选框。