Java @Documented
怪 咖@ 人气:0@Documented
和@Deprecated
注解长得有点像,@Deprecated
是用来标注某个类或者方法不建议再继续使用,@Documented
只能用在注解上,如果一个注解@B,被@Documented
标注,那么被@B修饰的类,生成文档时,会显示@B。如果@B没有被@Documented
标注,最终生成的文档中就不会显示@B。这里的生成文档指的JavaDoc文档!
@Deprecated
注解基本上所有框架自定义的注解都会添加,所谓javadoc其实就是JDK给我们提供的一个生成文档的工具!
使用示例如下:
@Documented public @interface DocumentedMy { String value() default "这是一个自定义类"; } @DocumentedMy public class MyTest1 { public String getStr() { return "123"; } }
生成javadoc文档有两种方式,一种是直接基于javadoc命令,一种是ide提供的!当然实际在开发当中我们很少会使用这个文档!除非我们要开源某个框架什么的才会用到!
通过ider生成javadoc文档:
1.点击项目当中的任意包
2.点击生成JavaDoc
3.指定生成位置
4.点击index.html
5.查看我们使用自定义注解的类,会发现他文档上面会展示这个自定义注解!
假如把自定义注解当中的@Documented去掉,然后使用该自定义注解的类,生成的文档就会不显示该注解!
@Deprecated:被标注过的方法,调用就会出现横线,表示不建议再继续使用,但是还能用!
/** * 测试Deprecated注解 * @author Administrator */ public class DeprecatedDemoTest { public static void main(String[]args) { // 使用DeprecatedClass里声明被过时的方法 DeprecatedClass.DeprecatedMethod(); } } class DeprecatedClass { @Deprecated public static void DeprecatedMethod() { } }
加载全部内容