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

Question

当我在Spring项目上运行Checkstyle时,它说:

- Missing package-info.java file.

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

Answer 1

用于存储javadoc描述.你可以在7.4.1找到它.JLS的命名包:

package-info.java如果它存在,建议取代package.htmljavadoc和其他类似的文档生成系统.如果存在此文件,则文档生成工具应在(可能带注释的)包声明之前查找包文档注释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创建向导中提供了一个简单(通常被忽略)的复选框.