怎样导出java注释文档格式 java生成注释

如何创建一个注解并使用

• 需求和实现

• 注解的定义
• 个人Demo

• 实际应用

需求和实现

今天在test瑞吉外卖项目时，想要去demo下生成一个自己定义的注解在项目中使用，先给出学习的例子后面慢慢更新上去

注解的定义

1. 编译检查
   Annotation具有“让编译器进行编译检查的作用”。
   配置反射可以直接动态解析代码并实现出来；
   例如，@SuppressWarnings, @Deprecated和@Override都具有编译检查作用。
2. 在反射中使用Annotation
   在反射的Class, Method, Field等函数中，有许多于Annotation相关的接口。
   这也意味着，我们可以在反射中解析并使用Annotation。
   根据Annotation生成帮助文档
   通过给Annotation注解加上@Documented标签，能使该Annotation标签出现在javadoc中。能够帮忙查看查看代码
3. 通过@Override, @Deprecated等，我们能很方便的了解程序的大致结构。
   另外，我们也可以通过自定义Annotation来实现一些功能。
4. 注解处理器
   如果没有用来读取注解的方法和工作，那么注解也就不会比注释更有用处了。使用注解的过程中，很重要的一部分就是创建于使用注解处理器。Java SE5扩展了反射机制的API，以帮助程序员快速的构造自定义注解处理器。
5. 框架
   在开发Java程序，尤其是Java EE应用的时候，总是免不了与各种配置文件打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架构来说，Spring、Struts和Hibernate这三个框架都有自己的XML格式的配置文件。这些配置文件需要与Java源代码保存同步，否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。把同一份信息保存在两个地方，总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。JDK 5中引入了源代码中的注解（annotation）这一机制。注解使得Java源代码中不但可以包含功能性的实现代码，还可以添加元数据。注解的功能类似于代码中的注释，所不同的是注解不是提供代码功能的说明，而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用，用来简化程序中的配置。
   因为注解大多都有自己的配置参数，而配置参数以名值对的方式出现，所以从某种角度来说，可以把注解看成是一个XML元素，该元素可以有不同的预定义的属性。而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解，就相当于把一部分元数据从XML文件移到了代码本身之中，在一个地方管理和维护。

总结：上面两段话其实已经阐述了java注解的主要作用之一，就是跟踪代码依赖性，实现替代配置文件功能。比较常见的是Spring等框架中的基于注解配置。现在的框架很多都使用了这种方式来减少配置文件的数量。基本上秉持着这么一个原则，与具体场景相关的配置应该使用注解的方式与数据关联，与具体场景无关的配置放于配置文件中。在另一方面我们还可以在通过设置注解的@Retention 级别在运行时使用反射对不同的注解进行处理。

个人Demo

import lombok.Data;

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface DemoAnnotation {

    int id() default 1;

    String name() default "";
}

@DemoAnnotation(id=1,name="annotationTest")
@Data
class ModelDemo{
    private int id;
    private String name;
}

class ImplForAnnotation{

    public static ModelDemo getModel(Class<?> clazz) throws IllegalAccessException, InstantiationException {
        DemoAnnotation demo = clazz.getAnnotation(DemoAnnotation.class);
        //通过newInstance()生成A实例，利用反射的结果进行设置
        ModelDemo model = (ModelDemo) clazz.newInstance();
        model.setId(demo.id());
        model.setName(demo.name());
        return model;
    }


}


class TestTheFinalResult{
    public static void main(String[] args) throws  Exception{
        ModelDemo a = ImplForAnnotation.getModel(ModelDemo.class);
        System.out.println("苹果商的ID为："+a.getId());
        System.out.println("苹果商的名字为："+a.getName());

    }
}

实际应用