Java注解之Documented Retention Target Inherited 自定义注解

@Documented

这个注解表明注解应该被javadoc工具记录，默认情况下，javadoc是不包括注解的，但如果声明注解时指定@Documented，则它会被javadoc之类的工具处理，所以注解类型信息也会被包括在生成的文件档中。

 

@Retention

这个注解说明，注解会被保留到那个阶段：

（1）RetentionPolicy.SOURCE--这个类型的Annotation只在源代码级别保留，编译时被会被忽略。

（2）RetentionPolicy.CLASS--这个类型的Annotation编译时被保留，在class文件中存在，但JVM将会忽略。

（3）RetentionPolicy.RUNTIME--这种类型的Annotation将被JVM保留，所以他们能在运行时被JVM或其他他使用反射机制的代码所读取和使用。

 

@Target

说明了Annotation所修饰的对象范围：

（1）CONSTRUCTOR，用于描述构造器。

（2）FIELD，用于描述域。

（3）LOCAL_VARIABLE，用于描述局部变量

（4）METHOD，用于描述方法

（5）PACKAGE，用于描述包

（6）PARAMETER，用于描述参数

（7）TYPE，用于描述类、接口或enum声明

 

@Inherited

阐述了某个被标准的类型是被继承的，如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将用于该class的子类。

 

自定义注解

使用@interface自定义注解时，自动继承java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式：

public @interface 注解名{定义体}

（1）只能用public或默认这两个访问权修饰。

（2）参数成员只能用基本类型等数据类型。

（3）如果只有一个参数成员，最好把参数名称设为“value”，后加小括号。

 

最后欢迎大家访问我的个人网站：1024s