Chinaunix首页 | 论坛 | 博客
  • 博客访问: 3305154
  • 博文数量: 626
  • 博客积分: 10
  • 博客等级: 民兵
  • 技术积分: 11080
  • 用 户 组: 普通用户
  • 注册时间: 2012-08-23 13:08
文章分类

全部博文(626)

文章存档

2015年(72)

2014年(48)

2013年(506)

分类: Java

2015-05-14 22:16:35

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的生成。比如:

点击(此处)折叠或打开

  1. /**
  2.  * dev1.ch包描述

  3.  * 基于Apache DbUtils库封装的工具库,简化开发
  4.  * @author Li Qiang

  5.  * date: 2015.5.13
  6.  * @since 1.7
  7.  * @version 1.0
  8.  *
  9.  */
  10. 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),你可以注释每一个单独的类型(类、接口、枚举等),如下所示:

点击(此处)折叠或打开

  1. @DEPRECATED
  2. PUBLIC CLASS CONTACT {
  3. }

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

点击(此处)折叠或打开

  1. @Deprecated
  2. package dev1.ch.domain;


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

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

 

阅读(4001) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~