來源：https://www.toutiao.com/i6992877750461825544/
一、pacakge-info.java介紹
pacakge-info.java是一個Java檔案，可以添加到任何的Java原始碼包中，pacakge-info.java的目標是提供一個包級的檔案說明或者是包級的注釋，
pacakge-info.java檔案中，唯一要求包含的內容是包的宣告陳述句，比如：
/**
* This is domain module, the core business logic is implemented here.
*
*/
package com.rickie.tracking.domain;
在Java 5之前，包級的檔案是package.html，是通過JavaDoc生成的，而在Java 5以上版本，包的描述以及相關的檔案都可以寫入pacakge-info.java檔案，它也用于JavaDoc的生成，
二、使用IDEA生成JavaDoc檔案
在IDEA中，選擇Tools/Generate JavaDoc…選單項，如圖所示：
在Generate JavaDoc視窗，輸入相關設定，
第一步：選擇生成JavaDoc檔案的范圍，下圖中，我們可以選擇Module模塊，
第二步：輸出目錄最好新建一個檔案夾，比較有條理和整潔，
第三步：區域（Locale）設定，決定檔案的語言，簡體中文就是zh_CN、繁體(臺灣)zh_tw、繁體(香港)zh-hk、英語(香港)en-hk、英語(美國)en-us、英語(英國)en-gb、英語(全球)en-ww，
設定完成后點擊【OK】按鈕即可生成Doc檔案，找到輸出目錄，然后打開 index.html 便能看生成的檔案，
查看類的檔案，如圖所示：
三、創建package-info檔案
package-info檔案不能隨便被創建，會報“This is not a valid Java qualified name”錯誤，類名無效，Java變數定義規范是：字母、數字、下劃線，還有那個不怎么常用的$符號，這個中劃線可不在之列，那怎么創建這個檔案呢？
可以創建一個普通的檔案，如圖所示，檔案名為package-info.java，或者更直接的辦法就是從別的專案中拷貝過來一個，
四、提供包級別的變數
如果想在包里面使用對應的變數，而不想讓其他包使用，就可以將變數放到package-info.java下面，實作分包自用的理念，
/**
* This is domain module, the core business logic is implemented here.
*
*/
package com.rickie.tracking.domain;
/**
* 包常量
*/
class PACKAGE_CONST{
public static final String COLA="《COLA 4.x架構入門和專案實踐》技術專欄首先介紹了COLA框架的使用入門，以及與IDEA開發工具的集成等等；然后基于COLA架構，創建DDD經典示例專案-貨物運輸系統，詳細介紹了DDD領域建模、適配層、應用層、領域層和基礎設施層的代碼開發、防腐層（ACL）設計與實作、領域事件（Domain Event）入門實踐、以及基于Kafka訊息中間件的訊息發布和訂閱等等，內容由淺入深，從開發實戰出發，逐步掌味訓于COLA架構和DDD領域建模思想構建復雜業務應用系統，";
}
在包內的任意類呼叫包常量，示例代碼如下所示：
public class Test {
public static void main(String[] args) {
System.out.println(PACKAGE_CONST.COLA);
}
}
在包外的任意類呼叫包常量，則會提示報錯，
五、提供包級別的注釋
使用JavaDoc的時候，通過在package-info.java添加注釋，生成JavaDoc實作對應包的注釋說明，
/**
* 描述: COLA 領域模塊<br>
* This is domain module, the core business logic is implemented here. <br>
* 創建時間: 2021/8/1 12:00 <br>
* @version v1.0
*/
package com.rickie.tracking.domain;
/**
* 包常量
*/
class PACKAGE_CONST{
public static final String COLA="《COLA 4.x架構入門和專案實踐》技術專欄首先介紹了COLA框架的使用入門，以及與IDEA開發工具的集成等等；然后基于COLA架構，創建DDD經典示例專案-貨物運輸系統，詳細介紹了DDD領域建模、適配層、應用層、領域層和基礎設施層的代碼開發、防腐層（ACL）設計與實作、領域事件（Domain Event）入門實踐、以及基于Kafka訊息中間件的訊息發布和訂閱等等，內容由淺入深，從開發實戰出發，逐步掌味訓于COLA架構和DDD領域建模思想構建復雜業務應用系統，";
}
生成對應的JavaDoc檔案，如圖所示：
近期熱文推薦：
1.1,000+ 道 Java面試題及答案整理(2021最新版)
2.別在再滿屏的 if/ else 了，試試策略模式，真香！！
3.臥槽！Java 中的 xx ≠ null 是什么新語法？
4.Spring Boot 2.5 重磅發布，黑暗模式太炸了！
5.《Java開發手冊（嵩山版）》最新發布，速速下載！
覺得不錯，別忘了隨手點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/300591.html
標籤：Java
上一篇：Java中ArrayList和LinkedList區別
下一篇：實作負載均衡的兩種方式