IDEA 自定义方法注释

为了方便生成方法的注释，并含有作者、时间、参数、返回值等信息，可以使用 IDEA 的 Live Templates 方法注释的自定义生成方式。

操作步骤

File -> Settings ->Editor -> Live Templates

添加模板组

点击右边加号，选择 Templates Group，输入 Group 名称，例如 user，点击确定

添加模板

选择刚才添加好的模板组 user，点击右边加号，选择 Live Templates，填写下面的参数。

Template text 参数如下

*
 * 
 * @author tlbcc 
 * @date $date$ $time$
 $param$
 $return$
 **/

点击 Edit variables，填写表格

param Default value

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 Default value

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

使用方式

在方法上输入/**后在输入回车，即可生成注释