IDEA 自定义方法注释模板

平时做项目的时候，免不了要写很多的注释，而 IDEA 自带的注释并不怎么好用，很多时候返回值、参数都无法正确识别出来

那么，就需要我们自己去自定义方法的注释模板，步骤如下

1. 先左上角 File -> Setting 打开设置

2. 然后左边依次点击 Editor -> Live Templates ，进入模板设置

3. 然后按照下方的顺序新建一个模板组 UserCostome （此处名字随意，代表自定义模板组）

4. 然后选中上面建好的 UserCostome 自定义模板组，点击右上角的加号，选择第一项 Live Template

5. 接下来开始填模板信息，其中第一项 Abbreviation 必须填写 * （因为 IDEA 默认的文档注释快捷键为 /** + Enter），第二项的描述信息随意

6. 接下来就是下方的模板正文，代码如下所示，注意空格格式，有的地方有缩进，有的地方没有！务必和下图一致！

模板正文如下：

*
 $param$
 $return$
 * @decription $decription$
 * @date $date$ $time$
*/

7. 填写完模板信息之后，点击下方警告中的蓝色字体 Define

8. 在弹出的框中选择作用域为 Java 所有文件范围内

9. 虽然配置了模板，但是里面的东西 IDEA 都不认识，所以要去设置一下

10. 点击右边的 Edit variables 按钮

11. 然后按照下图所示的进行设置，一定要注意，有的是 Expression 下填，有的是 Default Value 下填

其中 Default value 中的代码如下：

该代码为 param 所对应的：

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ' '}else{result+='\\n' + ' * @param ' + params[i] + ' '}}; return result;}", methodParameters());

改代码为 return 所对应的

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());

填好之后保存关闭即可，切记位置别填错

12. 到此为止，模板设置完成，随便写一个方法，写完它的返回值、参数列表

public List<String> getH(String name, Integer id, List<Integer> dataList, Map<String, Tags> map) {
    return new ArrayList<>();
}

13. 然后在该方法上面使用 /** + Enter 生成模板，出现下图所示，代表模板配置成功！