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

Question

当我在Spring项目上运行Checkstyle时，它说：

- Missing package-info.java file.

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

Answer 1

用于存储javadoc描述。您可以在JLS的7.4.1. Named Packages找到它：

  

建议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;

Also check this answer

更新 from here

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

  

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