优彩app下载-package-info.java文件详解

一、pacakge-info.java介绍

pacakge-info.java是一个Java文件,能够添加到任何的Java源码包中。pacakge-info.java的方针是供给一个包级的文档阐明或者是包级的注释。

pacakge-info.java文件中,仅有要求包括的内容是包的声明句子,比方:

p优彩app下载-package-info.java文件详解ackage com.ch.service;

二、包文档

在Java 5之前,包级的文档是package.html,是经过JavaDoc生成的。而在Java 5以上版别,包的描绘以及相关的文档都能够写入paca优彩app下载-package-info.java文件详解kge-info.java文件,它也用于JavaDoc的生成。比方:

/**
* dev1.ch包描绘

* 根据Apache DbUtils库封装的东西库,简化开发
* @author Li Qiang

* date: 2015.5.13
* @since 1.7
* @vers厌食症ion 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.优彩app下载-package-info.java文件详解ANNOTATION_TYPE (应用于另一个注解上)

比方,想让包中的全部类型过期(Deprecate),你能够注释每一个独自的类型(类、接口、枚举等),如下所示:

@DEPRECATED
PUBLIC CLASS CONTACT {
}

或者是能够在package-info.java包声明文件中运用@Deprecated注释,它能够让包中的全部均过期。

@Deprecated

package dev1.ch.domain;

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

能够手动在包目录下创立package-info.java文件,也能够经过Eclipse东西完成这一点。

写在最终:

码字不易看到最终了,那就点个重视呗,只保藏不点重视的都是在耍流氓!

重视并私信我“架构”,免费送一套Java架构材料,先到先得!