什么是包信息.java以及如何将其添加到我的项目中?帮助向程序包添加程序包信息.java

2022-09-01 12:06:08

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

- Missing package-info.java file.
  1. 什么是包信息.java它有什么用处?
  2. 我该如何处理此消息?

答案 1

用于存储 javadoc 描述。您可以在7.4.1中找到它。 Java® 语言规范的命名包:

建议 ,如果存在,则代替 javadoc 和其他类似的文档生成系统。如果此文件存在,则文档生成工具应在 中紧挨着(可能带注释的)包声明之前查找包文档注释。通过这种方式,成为包级注释和文档的唯一存储库。如果将来需要添加任何其他包级信息,则此文件应该可以方便地获取此信息。package-info.javapackage.htmlpackage-info.javapackage-info.java

例如:

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

另请检查此答案

从这里更新

帮助向程序包添加程序包信息.java

虽然您可以手动将包信息.java文件添加到包中(就像可以手动创建 Java 类一样),但 IDE 通常提供在每次创建新包时都包含包信息.java文件的选项。Eclipse(如下所示)在“新建 Java 包”创建向导中提供了一个简单(且经常被忽视)的复选框。

enter image description here


答案 2

推荐