在java项目中创建package以后,可以在package下放一个package-info.java文件。
这个文件有什么作用?如何生成?
三个作用:
-
为标注在包上Annotation提供便利;
-
声明友好类和包常量;
比如一个包中有很多的内部访问的类或常量,就可以统一的放到package-info类中,这样就方便,而且集中管理,减少friendly类到处游走的情况,看例子:
//这里是包类,声明一个包使用的公共类,强调的是包访问权限
class PkgClass{
public void test(){
}
}
//包常量,只运行包内访问,适用于分“包”开发
class PkgConst{
static final String PACAKGE_CONST="ABC";
}
- 提供包的整体注释说明。
Package Documentation
Prior to Java 5, package level documentation (the documentation shown in Javadocs for a package) was placed in package.html. Today, the description and other related documentation for a p