package-info.java

package-info.java类的功能

它是为它所在的包服务的。

一、如果一个包上需要加注解，则只能加在该包下的package-info.java文件中.
            Package annotations must be in file package-info.java

二、声明友好类和包常量.
            对于默认访问权限的类(即不加public、private这类修改符的类)，通常放在某个public类文件里边，
            如这友好类比较多的话，就会比较乱，不好管理。那么，可以将这些类全放到package-info.java文件中.
            类似的，包常量，散放在各个public类中，也不易管理，可以放在package-info.java文件中.

三、提供包的注释说明，这些注释文字会出现在javadoc生成的文档中。

 

"package-info"中包含一个横线"-"，不是一个合法的类名，
所有在eclipse中不能通过新建类的方法创建这个java文件。
通常是通过其它编辑器创建好该文件后，复制到对应的包下。

 

 

 package-info.java

/**
 * 本包的注释说明
 */
@MyPackageAnnotation   // 包注解
package com.linusiyu.common;

import com.linusiyu.annotation.MyPackageAnnotation;

/** 友好类. */
class FriendlyClass{
    public void show(){
        System.out.println("show! show in FriendlyClass, show in package-info.java! ");
    }
    
    void foo(){
        System.out.println("fun! fun in FriendlyClass, fun in package-info.java! ");
    }
}

/** 包常量. */
class CommonConstant{
    public static final int PERIOD_SECOND = 30;
    static final String CHARSET = "UTF-8";
}