packageinfo.java_package-info.java文件详解

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包描述

* 基于Apache DbUtils库封装的工具库，简化开发

* @author Li Qiang

* 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工具实现这一点。

packageinfo.java_package-info.java文件详解相关推荐

Android中R.java文件详解
R.java文件有两种,两种文件作用一样都是获取资源的引用,区别在于一个存放着我们写的项目中资源的引用,另一个存放着系统定义好的一些资源 1.1 项目的R.java文件先说第一种是项目编译出来的R. ...
cmd编译运行Java文件详解
①准备工作首先用记事本编写HelloWorld.java放至G:\Javaspace路径 public class HelloWorld{ public static void main(Strin ...
【java学习之路】（java框架）004.Mybatis SQL映射文件详解
02Mybatis SQL映射文件详解在之前我们学习了mybatis的全局配置文件,下面我们开始学习mybatis的映射文件,在映射文件中,可以编写以下的顶级元素标签: cache – 该命名空 ...
XML格式文件详解及Java解析XML文件内容方法
XML格式文件详解 1.概述 XML,即可扩展标记语言,XML是互联网数据传输的重要工具,它可以跨越互联网任何的平台,不受编程语言和操作系统的限制,可以说它是一个拥有互联网最高级别通行证的数据携带者. ...
Java 打 jar 包时，MANIFEST.MF 文件详解
具体详情,详见<MANIFEST.MF文件详解> manifest.mf 的编写规则不能有空行和空格的地方第一行不可以是空行(第一行的行前不可以有空行),行与行之间不能有空行,每行的行 ...
Mybatis复习笔记3：映射文件详解
映射文件详解参数处理(#和$的区别) #{}:可以获取map中的值或者实体对象属性的值: ${}:可以获取map中的值或者实体对象属性的值: select * from person where i ...
Apache Thrift - java开发详解
2019独角兽企业重金招聘Python工程师标准>>> Apache Thrift - java开发详解博客分类: java 架构中间件 1.添加依赖 jar <depen ...
javaweb web.xml文件详解
web.xml文件详解前言:一般的web工程中都会用到web.xml,web.xml主要用来配置,可以方便的开发web工程.web.xml主要用来配置Filter.Listener.Servlet等 ...
Java虚拟机详解----JVM常见问题总结
[正文] 声明:本文只是做一个总结,有关jvm的详细知识可以参考本人之前的系列文章,尤其是那篇:Java虚拟机详解04----GC算法和种类.那篇文章和本文是面试时的重点. 面试必问关键词:JVM垃圾 ...

packageinfo.java_package-info.java文件详解

packageinfo.java_package-info.java文件详解相关推荐

最新文章

热门文章