Java中的package-info.java作用

【JAVA】package-info.java 的用法 摘要: package-info.java是Java中用于提供包级文档和注释的特殊文件,替代了早期package.html的作用。它支持包级别的Javadoc注释、自定义注解(如@Deprecated标记废弃包)以及声明包内默认访问权限的常量类。创建时需直接命名为package-info.java,内容仅需package声明。通过IDEA生成Javadoc时需配置编码参数避免乱码。此外,包注解可通过反射获取,而包内常量仅限同包访问。该文件是组织包元数据和文档的重要工具。 阅读详情

前言

  之前在Eclipse中,总是会不小心勾选到这个复选框,之前并没有怎么在意这个java文件,毕竟生成之后只有以下这么点内容。
  
  
  而且你也不能直接创建package-info文件,因为编辑器会报 Type name is not valid 错误,类名无效。我也尝试在上述生成的 package-info.java 文件中定义一个class,由于Java变量定义的规范是由字母、数字、下划线和 $ 符号组成且首字母不为数字,不允许有 - , 所以这个显然是行不通的。
  
  所以我就很纳闷,这东西到底有什么作用?

作用

  查看了一些资料,总结下,大概的情况就是 package-info.java 文件为包级文档和包级别注释提供一个地方。而且该文件唯一必须包含的是包的声明。例如上述创建的 package-info.java 文件中的 package com.bigsea.test,与此同时,这个 package-info.java 也必须位于 com.bigsea.test 包中。

包文档

  软件包的描述和其他相关文档可以写在 package-info.java 文件中,并用于生成 Javadocs (关于如何生成 Javadocs 请自行谷歌或者百度,这里不做介绍)。
  我这里做个示例。
  
  

包注释

  package-info.java 文件包含包级别的注释。如以下图示。
  
  我这里也同样的举个例子。
  以我的工具包作为示例。比如你想弃用一个包中的所有类型。你可以通过使用 @Deprecated 注解每个单独的类型,或者,你可以在 package-info.java 中的 package 声明上使用 @Deprecated。
  
  
  在 com.bigsea.test 中新建一个 Test 类测试下。看到如下的结果。
  
  也就是说,你在 package-info.java 中的 package 声明上使用 @Deprecated,这样一来相当于贬低了对应包中的所有对应的类、接口、枚举等。

【Java的package-info.java文件支持 package-info.java的用途,简单地说,package-info是一个java文件,可以添加到任何Java包中。package-info.java文件目前有两个用途,包级文档的存放位置、包级别注释的存放位置,除了这两点外还可以根据需要扩展用例。将来如果需要添加任何包级别的功能,此文件将是一个完美的位置。 阅读详情

相关推荐

【Qt】QByteArray详解

对象共享同一份数据,直到修改时才进行深拷贝,以节省内存和计算资源。:可存储任意二进制数据(如图片、音频、协议数据),不依赖字符编码。与编码(如 UTF-8、Latin-1)之间的桥梁(例如。• 补零规则确保奇数字符串能正确解析,避免数据截断。:内部自动分配和释放内存,无需手动管理。将输入的字符串视为十六进制编码数据,返回实际数据长度(不包括结尾的。的输入必须是有效的十六进制字符(,但针对 Qt 框架做了优化。:处理加密后的二进制结果(如。• 如果输入字符串长度为奇数,• 若输入长度为奇数,自动在。

CSUC的博客 1599

Java学习系列:package-info.java的作用

学习开源源码的时候,发现每个目录都有一个package-info.java文件,查找其用法,并整理总结。

枫夜 2万+

ACM算法模板 · 一些常用的算法模板-模板合集(打比赛专用)

萌新常用的都在这了,本萌新的模板集。

张天枭の博客 5万+

一文带你看懂:不为人知的 package-info.java 文件

许多同学日常开发时,都不太注意到,原来自己维护这么久的 web 工程中,居然还有 package-info.java 这么一个类。但只要我们在 idea 中搜索一下,就能够发现很多依赖包,都用到了这个类的实现。那么,下面我们一起研究下,到底什么是package-info.java 类文件~~【目录】1)注解技术2)package-info类拆解3)动态ClassLoad...

Diligence is the mother of success. 1万+

OpenSees入门指南:从零开始的环境配置与TCL脚本实战

本文提供了一份详细的OpenSees入门指南,涵盖从零开始的环境配置到TCL脚本实战的全过程。文章重点讲解了OpenSees的安装步骤、环境变量设置,并推荐了高效的VS Code集成开发环境配置方法。通过一个简支梁分析的完整TCL脚本示例,手把手引导读者完成第一个非线性有限元分析,帮助土木工程与结构工程领域的研究者与学生快速上手这一强大的开源分析工具。

weixin_28829339的博客 339

DeepMD-kit描述子机制解析:从原子坐标到不变性特征

本文深入解析DeepMD-kit描述子机制,详细阐述如何将原子坐标转换为具有平移、旋转和排列不变性的特征表示。探讨了se_e2_a、se_e3等不同描述子的适用场景及性能优化技巧,帮助读者掌握这一关键技术在分子模拟中的应用实践。

weixin_42520661的博客 340

package-info.java的作用

目录 一、提供包级别的注释 1.在idea里的体现: 2.在Javadocs里的体现: 二、提供包级别的注解 三、提供包级别的友好类和变量 1.在同一个包里能正常使用 2.在别的包里就不能使用,包括子包也不能使用 一、提供包级别的注释 如在component包里放了package-info.java /** * 组件 */ package com.xxx.component; 在component.config包下放了package-info.java /** * 组.

lzhfdxhxm的博客 838

保姆级教程:在Ubuntu 20.04上从零搞定ROS Noetic和RealSense驱动,为无人机开发铺路

本文提供了一份详细的Ubuntu 20.04环境下ROS Noetic和RealSense驱动安装指南,专为无人机开发环境搭建设计。从系统配置、ROS安装到RealSense驱动集成,涵盖所有关键步骤和常见问题解决方案,帮助开发者快速搭建自主空中机器人开发平台。

weixin_30329623的博客 65

java package-info_PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了成功...

weixin_32165903的博客 1129

基于 InceptionNeXt 模块增强的 YOLOv8 模型:针对多尺度目标检测的改进与实现

modules.py。

know_F0727的博客 208

Spark中Application、Job、Stage和Task区别详解

在Spark中,有一些关键的概念,如Application、Job、Stage和Task,它们描述了Spark作业的不同层次和组成部分。下面我将详细介绍每个概念,并通过示例说明它们之间的区别。

优快云 精品推荐 907

package-info.java 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了

ding的专栏 3408

霍尼韦尔SoftMaster使用说明

霍尼韦尔SoftMaster使用说明

PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了

lazythinker的专栏 4万+

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

package-info.java_package-info.java 作用及用法详解

这个文件的特殊性说完了,那再说说它有什么作用,它有三个作用:为标注在包上Annotation提供便利;声明友好类和包常量;提供包的整体注释说明。我们来建立一个项目演示这三个作用,建立一个package-info的Java Project,在com.company包三个类:package-info.java是我们重点关注的,PkgAnnotation.java是一个标注在包上的注解定义,Client...

weixin_39613692的博客 468

华为的C语言编程规范.pdf

华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。

package-info.java作用详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了成功

wenwenxiong的专栏 1701

开源项目中经常看到package-info.java文件,你知道其作用吗?

点击上方“码农突围”,马上关注这里是码农充电第一站,回复“666”,获取一份专属大礼包真爱,请设置“星标”或点个“在看一、pacakge-info.java介绍pacakge-info.j...

欢迎关注公众号:【码农突围】,回复9999,可以获取一份LeetCode刷题笔记 446
上一篇: 【微信小程序】Python 脚本跳一跳高分技巧
下一篇: 【Tomcat】IDEA下跟踪查看源码
黑豪Horace
博客等级 码龄10年 85粉丝 74原创
评论 3
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值