共计 2215 个字符，预计需要花费 6 分钟才能阅读完成。
起源：https://www.toutiao.com/i6992…
一、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 开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞 + 转发哦！
