IDEA设置注释模板最佳实践

Posted 2021-01-05 leap

效果

在方法上输入/**，然后按tab键，生成的效果如下

配置步骤

1. 在Live Templates中添加模板组，命名随意，主要是为了存放自定义的模板，方便管理

2. 在模板组下添加一个模板，具体配置如下

1. Abbreviation 填写 *

（注：曾经我填写的是/** ，发现拦截/**会导致某些情况下无法获取对应参数的）

2. Template text 填写

* 
 * 
 * 
 $param$
 * @author XxxYyyZzz
 * @date $date$   
*/ 

3. 点击Edit variables，date字段选择date()，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()) 

4. 在Expand with中选择tab，然后点击Apply即可

（也可选择其他按键，表示触发的按键，个人比较喜欢用tab，避免与原有按键冲突）