标签 说明 标签类型
    @author 作者 作者标识 包、 类、接口
    @version 版本号 版本号 包、 类、接口
    @param 参数名 描述 方法的入参名及描述信息，如入参有特别要求，可在此注释。 构造函数、 方法
    @return 描述 对函数返回值的注释 方法
    @deprecated 过期文本 标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、 方法
    @throws异常类名 构造函数或方法所会抛出的异常。 构造函数、 方法
    @exception 异常类名 同@throws。 构造函数、 方法
    @see 引用 查看相关内容，如类、方法、变量等。 包、类、接口、值域、构造函数、 方法
    @since 描述文本 API在什么程序的什么版本后开发支持。 包、类、接口、值域、构造函数、 方法
    {@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。 包、类、接口、值域、构造函数、 方法
    {@value} 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。 静态值域

    此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签，由于不常使用，这里不再展开… 感兴趣的同学可以参考 官方文档 或者 菜鸟教程

    javadoc 的使用，个人更多的是参考Spring源码里面的使用方式，如下示例：

    • 用法举例 ```java package com.fittime.manageworkbench;

    import org.springframework.util.StringUtils;

    /**

    • @author fxbin
    • @version 1.0
    • @since 2021/6/15 4:51 下午 */ public class JavadocExample {
    1. public static void main(String[] args) throws Exception {
    2.     System.out.println(javadocExe("1"));
    3. }
    5. /**
    6.  * javadocExe
    7.  *
    8.  * @since 2021/6/15 4:55 下午
    9.  * @param parameter 参数，{@link String} 类型
    10.  * @return java.lang.String
    11.  * @see String
    12.  */
    13. public static String javadocExe (String parameter) throws Exception {
    14.     if (StringUtils.isEmpty(parameter)) {
    15.         return "";
    16.     }
    17.     return parameter;
    18. }

    }

    3. 分享我的IDEA 自定义 Javadoc 模板
    5. - method doc
    6. ```java
    7. *
    8.  * $name$
    9.  *
    10.  * @since $date$ $time$
    11.  $param$
    12.  * @return $return$
    13.  */
    15. name: methodName()
    16. param: groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())