`

@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
分享到:
评论

相关推荐

    5分钟搞懂java注解@Annotation的具体使用

    "Java 注解 @Annotation 的具体使用" Java 中的注解(Annotation)是一种元数据,用于提供关于程序元素(如类、方法、字段等)的信息。Java 5 中引入了注解机制,自此以来,注解在 Java 中扮演着越来越重要的角色,...

    Java自定义注解Annotation的使用

    ### Java自定义注解Annotation的使用 #### 1. 前言 自从JDK 1.5引入了注解这一特性以来,它已经成为Java开发中的一个重要组成部分。注解最初是为了推动EJB 3.0的普及和发展而设计的,其目的是减少配置文件的使用,...

    Annotation注解的介绍和使用

    #### 五、使用反射读取RUNTIME的Annotation信息 通过Java的反射机制,可以在运行时访问和处理注解信息,这对于框架和工具的开发尤其有用。 ```java Field field = clazz.getDeclaredField("fieldName"); ...

    自定义注解annotation及用法

    元注解是用于注解其他注解的注解,如`@Retention`, `@Target`, `@Documented`, `@Inherited`。例如,`@Target`指定注解可以应用于哪些程序元素(类、方法等)。 ```java @Target(ElementType.METHOD) @Retention...

    Annotation手册

    例如`@Retention`定义Annotation的生命周期(编译时、类加载时或运行时),`@Target`指定Annotation可以应用到哪些程序元素,`@Documented`指示是否将Annotation包含在生成的Javadoc中。 总结来说,Java Annotation...

    annotation

    - **Annotation的声明**:注解使用类似于修饰符的语法进行声明,可以应用到不同的程序元素上,如`@Override`用于方法重写标识。 - **Annotation类型**:定义注解的接口,指定了注解的名称、成员及其默认值。注解类型...

    疯狂java讲义29 电子版 pdf

    在讨论《疯狂java讲义》电子版PDF中关于javadoc工具的使用及其对注解的处理时,我们需要先了解javadoc工具是什么,以及注解(Annotation)在Java中的作用。javadoc是Java提供的一个工具,它可以自动提取Java源代码中...

    Java Annotation手册

    要创建注解处理器,需要定义一个实现 javax.annotation.processing.Processor 的类,并使用 @Processor 注解进行标记。处理器会自动检测到包含目标注解的源代码并执行处理逻辑。 三、元注解 3.1 元注解定义 元注解...

    JDK 5 提供的注解:Target、Inherited和Documented的区别

    如果一个注解声明时使用了`@Documented`,那么当生成Javadoc时,这个注解及其值将会被包含在文档中。这对于提高代码的可理解性非常有帮助,因为它使得阅读文档的开发者可以了解到这些元数据。没有使用`@Documented`...

    java annotation 实例

    Java注解(Annotation)是Java语言提供的一种元数据机制,用于在代码中插入额外的信息,这些信息可以被编译器或运行时环境读取。它们主要用于简化代码的维护、提高可读性,以及实现编译时和运行时的检查。在本实例中...

    Java元注解是Java注解的重要特性,下面我就来详解常见的4大Java元注解

    如果想让注解被包含在 JavaDoc 中,就需要使用 @Documented 注解。 @Documented 的作用是指定注解是否包含在 JavaDoc 中,从而提高注解的可读性和可维护性。 4.@Inherited @Inherited 用于指定注解是否可以被子类...

    Java 5 annotation 学习笔记

    Java 5引入的注解(Annotation)是一种元数据,它提供了在代码中嵌入信息的方式,这些信息可以被编译器、JVM或其他工具在编译时或运行时使用。注解可以用来简化代码,提高可维护性,并帮助工具进行静态分析。 1. ...

    02-Java注解面试题(2题)-新增.pdf

    @Documented meta-annotation 用于描述其他类型的 annotation 应该被作为被标注的程序成员的公共 API,因此可以被例如 javadoc 此类的工具文档化。 4. @Inherited @Inherited meta-annotation 阐述了某个被标注的...

    java 自定义注解

    CustomAnnotation annotation = clazz.getAnnotation(CustomAnnotation.class); if (annotation != null) { System.out.println("Author: " + annotation.author()); System.out.println("Version: " + annotation...

    Java-Annotation使用大全.doc

    Java 注解(Annotation)是Java语言中的一个重要特性,它为程序元素提供了附加信息,这些信息可以用于编译器检查、代码分析、运行时处理等多种用途。注解在代码中类似于修饰符,可以应用于包、类、接口、方法、字段、...

    java 注解annotation的使用以及反射如何获取注解

    Java注解(Annotation)是Java语言提供的一种元数据机制,用于向编译器或JVM提供额外的信息。这些信息可以用来验证代码、控制代码生成、配置应用等。注解是自Java 5版本引入的特性,它使得程序员可以在源代码中嵌入...

    Java实战篇:设计自己的Annotation.pdf

    ### Java实战篇:设计自己的Annotation #### 一、概述 在Java编程中,注解(Annotation)作为一种元数据,能够为代码提供额外的信息,并且在编译时或运行时可以被处理工具读取和利用。自Java 1.5版本引入以来,...

    Annotation--学习:限定使用、文档、继承

    在Java编程语言中,注解(Annotation)是一种元数据,它提供了在代码中附加信息的能力,这些信息可以被编译器或运行时环境用来验证、处理或增强代码的行为。本篇我们将深入探讨“限定使用、文档、继承”这三个关键...

    Java Annotation注解.doc

    **为什么使用Annotation?** 1. **减少模板代码**:通过使用注解,开发者可以避免编写大量重复的模板代码,例如在创建JAX-RPC Web服务时,可以使用注解来自动生成接口和实现。 2. **简化配置文件**:某些API需要与...

    使用annotation获取实体类注释

    这篇博客“使用annotation获取实体类注释”主要探讨了如何利用注解来增强代码的可读性和可维护性,同时介绍了如何从实体类中获取已定义的注解信息。以下是关于这个主题的一些关键知识点: 1. **注解定义**:注解以`...

Global site tag (gtag.js) - Google Analytics