javaAPI元注解之Documented

时间:2024-10-14 13:02:57

1、且看此注解的定义:有三个声明。(1)document:生成API帮助文档时显示注解。(2)Retention:会被jvm保留。(3)Target:是元注解。

javaAPI元注解之Documented

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

javaAPI元注解之Documented

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

javaAPI元注解之Documented

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

javaAPI元注解之Documented

5、使用ecplise自带的Javadoc工具,生成javadoc文档,注意类里面不要有中文注释,否茸垂扌馔则会可能不成功。选中要生成的类,点击Project,然后找到generate javadoc

javaAPI元注解之Documented

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

javaAPI元注解之Documented

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

javaAPI元注解之Documented
javaAPI元注解之Documented
javaAPI元注解之Documented

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

© 手抄报圈