java 应用程序 spring spring javadoc

@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

如下为以 @PostMapping 为例生成的 JavaDoc 文档