Java教程

package-info.java的作用

本文主要是介绍package-info.java的作用,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!

目录

 

一、提供包级别的注释

1.在idea里的体现:

2.在Javadocs里的体现:

二、提供包级别的注解

三、提供包级别的友好类和变量

1.在同一个包里能正常使用

2.在别的包里就不能使用,包括子包也不能使用


一、提供包级别的注释

如在component包里放了package-info.java

/**
 * 组件
 */
package com.xxx.component;

在component.config包下放了package-info.java

/**
 * 组件配置
 */
package com.xxx.component.config;

1.在idea里的体现:

鼠标在component上悬浮的时候,就会显示component包的注释

鼠标在config上悬浮的时候,就会显示config包的注释

2.在Javadocs里的体现:

类似下图,package的注释:

二、提供包级别的注解

比如,在helper包下建package-info.java,如下:

@Deprecated
package com.xxx.helper;

那么表示整个包都过时了,不推荐使用:

当然,前提是这个注解本身支持包级别,如@Deprecated

也可以自定义包级别的注解,然后在package-info.java里使用,这里就不演示了。

三、提供包级别的友好类和变量

比如:

/**
 * 组件
 */
package com.xxx.component;

 class CompomentHelper {
    public static String getCompomentPayName() {
        return "test";
    }
}

class CompomentErrorCode {
    public static final String COMPOMENT_PAY_001="0001";
}

/**
 * 组件
 */
package com.xxx.component;

class CompomentHelper {
    public static String getCompomentPayName() {
        return "test";
    }
}

class CompomentErrorCode {
    public static final String COMPOMENT_PAY_001="0001";
}

1.在同一个包里能正常使用

2.在别的包里就不能使用,包括子包也不能使用

 

 

这篇关于package-info.java的作用的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!