`

@Documented Annotation的使用

阅读更多

@Documented Annotation的使用:

@Documented Annotation的作用是在生成javadoc文档的时候将该Annotation也写入到文档中。

java 代码
  1. package com.test;   
  2.   
  3. import java.lang.annotation.Documented;   
  4.   
  5. @Documented  
  6. public @interface DocumentTest {   
  7.     String hello();   
  8. }   

 

java 代码
  1. package com.test;   
  2.   
  3.   
  4. public class DocumentClass {   
  5.     /**  
  6.      * this is method of doSomething  
  7.      */  
  8.     @DocumentTest(hello = "yahaitt")   
  9.     public void doSomething()   
  10.     {   
  11.         System.out.println("do something");   
  12.     }   
  13.        
  14.     /**  
  15.      * this is method of say  
  16.      */  
  17.     public void say()   
  18.     {   
  19.         System.out.println("say");   
  20.     }   
  21. }   

 

生成的doc文件中如下:

doSomething

@DocumentTest(hello="yahaitt")
public void doSomething()
this is method of doSomething
分享到:
评论

相关推荐

    观看韩顺平学习整理java的笔记到异常

    基本的 Annotation 介绍 16 @Override 注解 16 @Override 使用说明 17 @Deprecated 注解 17 @SuppressWarnings 注解 17 元注解 19 @Retention 注解 19 @Target 注解 19 @Documented注解 20 @Inherited 注解 20 异常-...

    Java中三种标准注解和四种元注解.pdf

     3.@Documented,  4.@Inherited  这些类型和它们所⽀持的类在java.lang.annotation包中可以找到。下⾯我们看⼀下每个元注解的作⽤和相应分参数的使⽤说明。  @Target:  @Target说明了Annotation所修饰的对象...

    java8源码-Annotation_demo:Annotation_demo

    java8 源码 Java注解 简介 由于无论在Java后台或者Android开发中我们经常遇到注解这个...通过@Target进行添加到注解中,说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Ann

    @SpringBootApplication注解到底做了什么,你真的了解吗?

    @Documented @Inherited @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), @Filter(type = ...

    JavaSE-注解与反射(框架底层实现机制)

    注解(Annotation)JDK5.0引入 ...@Documented:是否生成注解在Javadoc种 @Inherited:子类可以继承父类的注解 自定义注解 @interface 注解名{} 属性为注解的参数:可以使用默认值 反射(框架设计的

    Java语言高级部分之注解是什么?

    元注解(JDK的元Annotation)4.1.@Target4.2.@Retention4.3.@Documented4.4.@Inherited4.5.@Result四、在程序中使用(解析)注解五、案例——简单的测试框架 一、注解是什么?  从JDK5开始,Java增加对元数据的支持...

    \java超强笔记(超级经典)

    静态方法可以是泛型方法(在修饰符和返回值之间写泛型),但是不可以使用类的泛型。 static void copyArrayToList(Object[] os,List<T> ls){ //错误,T为类的泛型 } static <E> void ...

    Java内功修炼系列:注解(Annotation)

    3.3 @Documented 3.4 @Inherited 3.5 @Repeatable 四 Java 预置的注解 4.1 @Deprecated 4.2 @Override 4.3 @SuppressWarnings 4.4 @SafeVarargs 4.5 @FunctionalInterface 五 注解的属性 5.1 属性的定义 5.2 注解的...

    Java版水果管理系统源码-huihe_2020summer:2020假期spring学习,vue留给你们了,有兴趣自己可以看官方文档,中文很

    注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 Java 语言中的类、方法、变量、参数和包等都可以被标注。 内置的注解 作用在代码的注解是 @Override - 检查该方法是否是重写方法。如果发现其...

    Java注解之Retention、Documented、Inherited介绍

    主要介绍了Java注解之Retention、Documented、Inherited注解介绍,本文内容和相关文章是系列文章,需要的朋友可以参考下

    疯狂JAVA讲义

    学生提问:当我们使用编译C程序时,不仅需要指定存放目标文件的位置,也需要指定目标文件的文件名,这里使用javac编译Java程序时怎么不需要指定目标文件的文件名呢? 13 1.5.3 运行Java程序 14 1.5.4 根据...

Global site tag (gtag.js) - Google Analytics