javaAPI元注解之Documented

javaAPI元注解之Documented

Documented注解是javaAPI中的四个元注解之一,只用于修饰注解,位于java.lang.annotation包下。

被Documented修饰的注解A(假设A,有点拗口),然后使用注解A去修饰某个类B(假设B,也可以是方法或者属性),在使用javadoc(不明白找度娘,或者继续向下看)命令将B生成API帮助文档时,将会把注解信息也显示在此文档中。

且看此注解的定义:有三个声明。

(1)document:生成API帮助文档时显示注解。

(2)Retention:会被jvm保留。

(3)Target:是元注解。

创建注解:有两个注解修饰符,表示这个注解用于修饰方法;这个注解被声明了Documented。

创建测试类:里面有两个方法一宿政侧个test,一个使用了我们新建的彩珠注解修饰的方法testMyDocumentAnnotation。

看一下Test注解,发现其没有被Documented修饰。

使用ecplise自带的Javadoc工具,生成javadoc文档,注意类里面不要有中文注释,否则会可能不成功。

选中要生成的类,点击Project,然后找到generate javadoc

选择一个路径,完成,然后在生成的目录下找到overview-tree.html用浏览器打开,单击我们的类。

在方法的详细信息中沃近,我们可以看到,test方法上没有注解,而testMyDocumentAnnotation上有注解,这就是加上了Documented的用处。

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