文档注释基于javadoc模板

类注释

/*** 暂无介绍** @author admin* @version 1.0.0* <dt><span class="simpleTagLabel">时间:</span></dt>* <dd>2023/2/24</dd>*/

方法注释

/*** 暂无描述** @author admin* @param args */

javadoc相关注解

IDE 配置Live Templates

打开设置界面：

File --> Settings

创建模板组：

Editor --> Live Templates --> 点击“+” --> 2.Template Group --> 输入名称，点击OK（我输入的是My Group）

创建模板：

选中新建的模板组（My Group） --> 点击“+” --> 1.Live Template

模板设置：

1.设置模板前缀，如果设置为，使用时 /* + Enter键（第5步设置该按键），如果设置为a，使用时 /*a + Enter键，其他类推

2.设置该模板应用范围，mothed表示方法，file表示类上面

3.填写模板内容，具体内容会在后面补充，可以参考

4.设置模板中变量的取值

5.设置执行按键，默认是Tab，我一般习惯改为Enter键。该功能主要配合步骤1中的模板前缀使用

6.设置模板应用范围，一般是点击第一个进行全选操作。

模板样例及取值设置

1.方法的注释模板：其中的author可以更改，其他一般默认即可

/*
*
$params$
* @return $returns$
* @exception $exception$
* @author DingDing
* @date $date$ $time$
*/

2.模板的变量取值设置

params：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) ? '\\r\\n' : '')}; return result", methodParameters())
returns：methodReturnType()
exception：expressionType(Expression)
date：date()
time：time()

IDE 配置File Templates

定义注释模板

File – Settings – Editor – File and Code Templates->右边选择需要定义的模板（以class类模板为例）

其中，红框内定义了很多变量，可以直接引用，例如：

这里注意标准的Javadoc是没有@date的注解的，如果要标记日期，可以在author后加入

@author ${USER} ON ${DATE}

/**
* ${DESCRIPTION}
* @author ${USER}
* @date ${DATE}
**/