2018-04-22 package-info.java文件详解

一、pacakge-info.java介绍

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

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

package com.ch.service;

二、包文档

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

/**
 * dev1.ch包描述<br>
 * 基于Apache DbUtils库封装的工具库,简化开发
 * @author Li Qiang<br>
 * date: 2015.5.13
 * @since 1.7
 * @version 1.0
 *
 */
package dev1.ch;

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


这里写图片描述

点击dev1.ch程序包的链接后显示:


这里写图片描述

三、包注释

注释对于程序员来说非常重要,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 dev1.ch.domain;

四、把package-info.java添加到包中

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


这里写图片描述
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,323评论 19 139
  • 普通,对于自己或者多数人来说,是平凡;平凡,对我来说只是周而复始;我左右,左右我,我都可能会觉得无能为力,可...
    鲸鲨鲸鲨阅读 1,228评论 0 1
  • 我以为不诉说心就不会痛 后来发现是个错 我以为不诉说你也会懂 后来觉察这份默契很遥远 我以为我说过你就会记得 结果...
    黄梅枝阅读 1,800评论 7 16
  • 生活中,我们总是抱怨太多,自己孤独,是因为没人理解,总是自命清高,怨别人太俗,其实,自己又何尝不是俗人一个...
    言行合一阅读 3,712评论 1 5
  • 9月29日到10月2日,我终于参加了向往已久的,在安徽六安由中国培训师大联盟主办的,陈中来老师(以下简称老陈,我能...
    旅者游侠_董磊阅读 6,233评论 0 0