注解：@Documented @Retention @Target

项目中发现自定义了一个注解：

自己定义了一个注解。这个新定义的注解有三个注解：

@Target

用于设定注解使用范围/作用目标。

ElementType是一个枚举类。

@Retention

注解的保留位置

• RetentionPolicy.SOURCE:这种类型的Annotations只在源代码级别保留,编译时就会被忽略,在class字节码文件中不包含。
• RetentionPolicy.CLASS:这种类型的Annotations编译时被保留,默认的保留策略,在class文件中存在,但JVM将会忽略,运行时无法获得。
• RetentionPolicy.RUNTIME:这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用。

https://blog.****.net/fn0723/article/details/84962441

• 这3个生命周期分别对应于：Java源文件(.java文件) —> .class文件 —> 内存中的字节码。
• 那怎么来选择合适的注解生命周期呢？

1. 首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。
2. 一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解，比如@Deprecated使用RUNTIME注解
3. 如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；
4. 如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，使用SOURCE 注解。

• 注解@Override用在方法上，当我们想重写一个方法时，在方法上加@Override，当我们方法的名字出错时，编译器就会报错
• 注解@Deprecated，用来表示某个类或属性或方法已经过时，不想别人再用时，在属性和方法上用@Deprecated修饰
• 注解@SuppressWarnings用来压制程序中出来的警告，比如在没有用泛型或是方法已经过时的时候
• 举个例子：Override的源码，作用对象为method，注解保留在.java文件中。
  
• 举个例子：Component注解，作用在类，接口和枚举上。一直到内存中都存活。
  
  

@Documented

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