码迷,mamicode.com
首页 > 编程语言 > 详细

package-info.java文件详解

时间:2015-05-14 23:56:08      阅读:595      评论:0      收藏:0      [点我收藏+]

标签:javadoc   package   

package-info.java文件详解

作者:chszs,转载需注明。博客主页:http://blog.csdn.net/chszs

一、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工具实现这一点。
技术分享

package-info.java文件详解

标签:javadoc   package   

原文地址:http://blog.csdn.net/chszs/article/details/45727249

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!