欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

「SpringBoot 相关注解」@Documented 元注解 - 使用 IDEA 生成 JavaDoc

程序员文章站 2022-03-14 19:20:32
...

@Documented 介绍

Documented.java 类位于 JDK 的 rt.jar 内,属于一个 JDK 注解

它是用来修饰注解的,是注解的注解,称之为元注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

@Documented 作用

被 @Documented 修饰的注解将包含在 JavaDoc 中 。此注解会被javadoc工具提取成文档。
常见注解基本都被 @Documented 修饰


使用 IDEA 生成 JavaDoc

「SpringBoot 相关注解」@Documented 元注解 - 使用 IDEA 生成 JavaDoc
「SpringBoot 相关注解」@Documented 元注解 - 使用 IDEA 生成 JavaDoc

如下为以 @PostMapping 为生成的 JavaDoc 文档
「SpringBoot 相关注解」@Documented 元注解 - 使用 IDEA 生成 JavaDoc
「SpringBoot 相关注解」@Documented 元注解 - 使用 IDEA 生成 JavaDoc

相关标签: 注解