package-info.java文件详解

欢迎关注我的社交账号：

博客园地址: http://www.cnblogs.com/jiangxinnju/p/4781259.html

GitHub地址: https://github.com/jiangxincode

知乎地址: https://www.zhihu.com/people/jiangxinnju

pacakge-info.java介绍

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

pacakge-info.java文件中，唯一要求包含的内容是包的声明语句，比如：

package edu.jiangxin.tools;

包文档

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

    /**
     * 常用工具包<br>
     * @author Jiangxin
     * @version 1.0
     *
     */
    package edu.jiangxin.tools;

上面的说明通过JavaDoc生成如下：

在添加package-info.java之后，部分IDE可以在代码中进行提示，如下图：

包注释

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

包注释当然是ElementType.PACKAGE了，除此之外，还有：

    ElementType.TYPE (class, interface, enum)
    ElementType.FIELD (instance variable)
    ElementType.METHOD ElementType.PARAMETER
    ElementType.CONSTRUCTOR
    ElementType.LOCAL_VARIABLE
    ElementType.ANNOTATION_TYPE

比如，想让包中的所有类型过时（Deprecate），你可以注释每一个单独的类型（类、接口、枚举等），如下所示：

    @DEPRECATED
    PUBLIC CLASS CONTACT {
    }

或者是可以在package-info.java包声明文件中使用@Deprecated注释，它可以让包中的一切均过时。

    @Deprecated
    package edu.jiangxin.tools;

把package-info.java添加到包中

可以手动在包目录下创建package-info.java文件，也可以通过Eclipse工具实现这一点。