javaAPI元注解之Documented

Documented注解属于java API里四个元注解中的一个，它仅用于修饰注解，在java.lang.annotation包中。

1、 来看此注解的定义：存在三个声明。

2、 生成API帮助文档时要显示注解。

3、 （2）Retention：将被jvm保留。

4、 Target属于元注解。

5、 创建一个注解，有两个修饰符，此注解用于修饰方法且被声明为Documented。

6、 创建一个测试类，该类包含两个方法，一个是test方法，另一个是被我们新建的注解修饰的testMyDocumentAnnotation方法。

7、 查看Test注解，发觉它未被Documented修饰。

8、 利用eclipse自带的Javadoc工具来生成javadoc文档，需注意类中别加中文注释，不然可能生成失败。

9、 选中需生成的类，点击Project，再找到generate javadoc。

10、 选一个路径并完成，接着于生成的目录里找到overview - tree.html，用浏览器打开后单击我们的类。

11、 在方法的详细情况里能看到，test方法无注解，testMyDocumentAnnotation方法有注解，这便是加上Documented的作用。

12、 给类或者字段等添加Documented是同样的道理。