packge-info.java

简介: packge-info.java是一个Java文件,可以添加到任何的Java源码包中。packge-info.java的目标是提供一个包级的文档说明或者是包级的注释。packge-info.java文件中,唯一要求包含的内容是包的声明语句,比如:package com.jephon.pkg;包文档在Java 5之前,包级的文档是package.html,是通过JavaDoc生成的。

packge-info.java是一个Java文件,可以添加到任何的Java源码包中。packge-info.java的目标是提供一个包级的文档说明或者是包级的注释。

packge-info.java文件中,唯一要求包含的内容是包的声明语句,比如:

package com.jephon.pkg;

包文档

在Java 5之前,包级的文档是package.html,是通过JavaDoc生成的。而在Java 5以上版本,包的描述以及相关的文档都可以写入packge-info.java文件,它也用于JavaDoc的生成。比如:

/**
 * 定时任务处理
 * Created by jephon on 2016/10/31.
 */
package com.jephon.task;

标红的会在通过javadoc生成的文档中有体现。

包注释

注解对于程序员来说非常重要,packge-info.java文件包含了包级的注解。我们还可以使用ElementType来自定义注释。 

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

比如,想让包中的所有类型过时(Deprecate),你可以注释每一个单独的类型(类、接口、枚举等),或者是可以在package-info.java包声明文件中使用@Deprecated注释,它可以让包中的一切均过时。

@Deprecated
package com.jephon.pkg;
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

 

 

 
 

 

目录
相关文章
|
数据采集 Java 测试技术
精准测试如何落地
在快速迭代的软件开发环境中,精准测试作为一种高效、针对性的测试方法,正逐步成为企业的首选。本文探讨了精准测试的落地方法、对质量指标的影响、数据统计与跟踪度量、提高投入产出收益率的策略及卡点数据的具体内容。通过优化测试用例、代码关联、技术融合及流程优化,精准测试能够显著提升软件质量和测试效率。
|
存储
GIGE 协议摘录 —— GVSP 协议(三)(下)
GIGE 协议摘录 —— GVSP 协议(三)
786 1
|
XML 数据可视化 API
Android经典实战之约束布局ConstraintLayout的实用技巧和经验
ConstraintLayout是Android中一款强大的布局管理器,它通过视图间的约束轻松创建复杂灵活的界面。相较于传统布局,它提供更高灵活性与性能。基本用法涉及XML定义约束,如视图与父布局对齐。此外,它支持百分比尺寸、偏移量控制等高级功能,并配有ConstraintSet和编辑器辅助设计。合理运用可显著提高布局效率及性能。
910 0
|
机器学习/深度学习 编解码 固态存储
YOLOv8改进之更换BiFPN并融合P2小目标检测层
BiFPN(Bi-directional Feature Pyramid Network)是一种用于目标检测和语义分割任务的神经网络架构,旨在改善特征金字塔网络(Feature Pyramid Network, FPN)的性能。FPN是一种用于处理多尺度信息的网络结构,通常与骨干网络(如ResNet或EfficientNet)结合使用,以生成不同分辨率的特征金字塔,从而提高对象检测和分割的性能。BiFPN在此基础上进行了改进,以更好地捕获多尺度信息和提高模型性能。
5920 0
|
缓存 算法 应用服务中间件
nginx 反向代理 与缓存功能
nginx 反向代理 与缓存功能
|
存储 NoSQL 安全
Redis(一)原理及基本命令(柔性数组)
Redis(一)原理及基本命令(柔性数组)
151 0
|
Web App开发 前端开发
chrome调试9-快速调试css数值及颜色图形动画
chrome调试9-快速调试css数值及颜色图形动画
519 0
chrome调试9-快速调试css数值及颜色图形动画
|
C语言
C语言实现汉诺塔问题【图解和演示】
本文,就将介绍汉诺问题的由来、原理、及C语言如何实现
盘点服装设计所经常性使用的软件-----ET(下篇)
盘点服装设计所经常性使用的软件-----ET(下篇)
295 1
盘点服装设计所经常性使用的软件-----ET(下篇)