天天看点

packge-info.java

packge-info.java是一个Java文件,可以添加到任何的Java源码包中。packge-info.java的目标是提供一个包级的文档说明或者是包级的注释。

packge-info.java文件中,唯一要求包含的内容是包的声明语句,比如:

在Java 5之前,包级的文档是package.html,是通过JavaDoc生成的。而在Java 5以上版本,包的描述以及相关的文档都可以写入packge-info.java文件,它也用于JavaDoc的生成。比如:

标红的会在通过javadoc生成的文档中有体现。

注解对于程序员来说非常重要,packge-info.java文件包含了包级的注解。我们还可以使用ElementType来自定义注释。 

比如,想让包中的所有类型过时(Deprecate),你可以注释每一个单独的类型(类、接口、枚举等),或者是可以在package-info.java包声明文件中使用@Deprecated注释,它可以让包中的一切均过时。