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文件详解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。