说明

pacakge-info.java 是一个Java文件，可以添加到任何的Java源码包中。

作用

提供一个 包级的文档说明 或者是 包级的注释。

创建

idea有直接创建该文件的方式，如下：

内容

必须内容

要有 包的声明语句

package top.malaoshi.student;

提供包级别的注释

在 package-info.java 添加包级别的注释，生成JavaDoc实现对应包的注释说明。

/**
* 与学生相关的包，如：Student bean，添加学生、删除学生、修改学生、查询学生等操作
*/
package top.malaoshi.student;

提供包级别的常量

如果想在包里面使用对应的常量，而不想让其他包使用，就可以将变量放到 package-info.java 中，实现分包自用的理念。

/**
* 与学生相关的包，如：Student bean，添加学生、删除学生、修改学生、查询学生等操作
*/
package top.malaoshi.student;

/**
* 包常量
*/
class PACKAGE_CONST{
    public static final String SCHOOL="清华大学";
}

在包内的任意普通类调用包常量，如下：

public class Test {
     public static void main(String[] args) {
         System.out.println(PACKAGE_CONST.SCHOOL);
     }
}

编译

编译后，没有 package-info 相关文件

参考：
https://segmentfault.com/a/1190000040692480

原文出处：/show_1IX74EF0p0Xl.html