package-info.java⽂件详解
欢迎关注我的社交账号:
pacakge-info.java介绍
pacakge-info.java是⼀个Java⽂件,可以添加到任何的Java源码包中。pacakge-info.java的⽬标是提供⼀个包级的⽂档说明或者是包级的注释。
pacakge-info.java⽂件中,唯⼀要求包含的内容是包的声明语句,⽐如:
package ls;
包⽂档
在Java 5之前,包级的⽂档是package.html,是通过JavaDoc⽣成的。⽽在Java 5以上版本,包的描述以及相关的⽂档都可以写⼊pacakge-info.java⽂件,它也⽤于JavaDoc的⽣成。⽐如:
/**
* 常⽤⼯具包<br>
* @author Jiangxin
* @version 1.0
*
*/
package ls;
上⾯的说明通过JavaDoc⽣成如下:
在添加package-info.java之后,部分IDE可以在代码中进⾏提⽰,如下图:
包注释
注释对于程序员来说⾮常重要,pacakge-info.java⽂件包含了包级的注释。我们还可以使⽤ElementType来⾃定义注释。
包注释当然是ElementType.PACKAGE了,除此之外,还有:
ElementType.TYPE (class, interface, enum)
ElementType.FIELD (instance variable)
ElementType.METHOD ElementType.PARAMETER
java创建文件ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE
⽐如,想让包中的所有类型过时(Deprecate),你可以注释每⼀个单独的类型(类、接⼝、枚举等),如下所⽰: @DEPRECATED
PUBLIC CLASS CONTACT {
}
或者是可以在package-info.java包声明⽂件中使⽤@Deprecated注释,它可以让包中的⼀切均过时。
@Deprecated
package ls;
把package-info.java添加到包中
可以⼿动在包⽬录下创建package-info.java⽂件,也可以通过Eclipse⼯具实现这⼀点。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论