当前位置: 首页 > 后端技术 > Java

开源项目经常看到package-info.java文件,有什么用?

时间:2023-04-01 18:45:54 Java

来源:https://www.toutiao.com/i6992...1.pacakge-info.java简介pacakge-info.java是一个Java文件,可以添加到任何Java源码包中。pacakge-info.java的目标是提供包级文档或包级注释。pacakge-info.java文件中,唯一需要的内容就是包的声明语句,例如:/***Thisisdomainmodule,核心业务逻辑在这里实现。**/packagecom.rickie.tracking。领域;在Java5之前,包级文档是package.html,它是通过JavaDoc生成的。在Java5以上的版本中,可以将包描述和相关文档写入pacakge-info.java文件中,该文件也用于生成JavaDoc。2、使用IDEA生成JavaDoc文档在IDEA中,选择Tools/GenerateJavaDoc...菜单项,如图:在GenerateJavaDoc窗口中,输入相关设置。第一步:选择生成JavaDoc文档的范围。在下图中,我们可以选择Module模块。第二步:输出目录最好新建一个文件夹,这样更有条理,更整洁。Step3:Locale设置决定文档的语言。简体中文为zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英文(香港)en-hk、英文(美国)en-us、英文(英国)en-gb、英文(全球)en-ww。设置完成后点击【确定】按钮生成Doc文档。导航到输出目录并打开index.html以查看生成的文档。查看类的文档,如图:3.创建package-info文件package-info文件不能随便创建,会报错“ThisisnotavalidJavaqualifiedname”,类name不合法,Java变量定义规范是:字母,数字,下划线,不常用的$符号,破折号不包括在内,那么如何创建这个文件呢?可以创建一个普通文件,如图,命名为package-info.java。或者更直接的方法是从另一个项目中复制一个。4.提供包级变量如果你想使用包中对应的变量,但又不想让其他包使用,你可以将变量放在package-info.java下,实现你的分包的概念自己使用。/***这是domain模块,核心业务逻辑在这里实现**/packagecom.rickie.tracking.domain;/***包常量*/classPACKAGE_CONST{publicstaticfinalStringCOLA="《COLA 4.x架构入门和项目实践》技术专栏首先介绍了COLA框架的使用介绍,以及与IDEA开发工具的集成等;然后基于COLA架构,打造了一个DDD经典实例项目——货物运输系统,并介绍了DDD领域建模、适配层、应用层详解,领域层和基础设施层代码开发,防腐层(ACL)设计与实现,领域事件(DomainEvent)入口实践,基于Kafka消息中间件的消息发布与订阅,等内容由浅入深,从开发实战开始,逐步掌握基于COLA架构和DDD领域建模思想的复杂业务应用系统的构建。示例代码如下:publicclassTest{publicstaticvoidmain(String[]args){System.out.println(PACKAGE_CONST.COLA);}}如果包外的任何类调用包常量,都会提示错误。5、提供包级注释在使用JavaDoc时,在package-info.java中添加注释,生成JavaDoc实现对应包的注释说明。/***描述:COLA领域模块
*这是领域模块,核心业务逻辑在这里实现。
*创建时间:2021/8/112:00
*@versionv1.0*/packagecom.rickie.tracking.domain;/***包常量*/classPACKAGE_CONST{publicstaticfinalStringCOLA="《COLA 4.x架构入门和项目实践》技术专栏首先介绍了COLA框架的介绍以及与IDEA开发工具的集成等;然后基于COLA架构,打造了一个DDD经典示例项目——货物运输系统,详细介绍了代码开发DDD领域建模、适配层、应用层、领域层和基础设施层、防腐层(ACL)设计与实现、领域事件(DomainEvent)入口实践、基于Kafka消息中间件的消息发布与订阅等。内容由浅入深,从实际开发出发,逐步掌握基于COLA架构和DDD领域建模思想构建复杂业务应用系统。”;}生成相应的JavaDoc文档,如图:近期热点文章推荐:1.1,000+Java面试题及答案(2021最新版)试试攻略模式,真香!!3.操!Java中xx≠null的新语法是什么?4、SpringBoot2.5发布,深色模式太炸了!5.《Java开发手册(嵩山版)》最新发布,赶快下载吧!感觉不错,别忘了点赞+转发!