富客户端程序设计实例 - Action层 - package-info.java 介绍

6年前


        为什么需要 package-info.java,原因在这里:Package annotations must be in file package-info.java 。
        package-info.java这个文件,通常会发现里面没有类申明,只有这个包的申明,和包上的Javadoc注释。一个类是一类或一组事物的描述,比如Dog这个类是描述旺财的,那package-info这个类总要有一个被描述或被陈述的对象。它是描述和记录本包信息。项目开发中,可以放置在包上的常用注解有:Struts的@Namespace@ParentPackage、Hibernate的@FilterDef和@TypeDef等。建议是Java 1.5以上版本都使用package-info.java来注释。
有三个作用:
    1、为标注在包上Annotation提供便利;
    2、声明友好类和包常量;
    3、提供包的整体注释说明。
    如何创建package-info.java:第一种直接的办法就是从别的项目中拷贝过来一个;第二种 IDE’s often offer you the option to include a package-info.java file each time you create a new package.  Eclipse, shown below, offers a simple (and often overlooked) checkbox in the New Java Package creation wizard:你每次创建一个新的包的时候,开发环境一般都会提示你是否添加这个文件,以Eclipse为例如下图所示: