IntelliJ IDEA方法注释模板设置说明

July 8, 2020

4263 views

1983 words

1 新建Template Group
IntelliJ IDEA方法注释模板设置说明1.png
命名为MyMethodTemplate
IntelliJ IDEA方法注释模板设置说明2.png
在MyMethodTemplate下新建Live Template，命名为*
IntelliJ IDEA方法注释模板设置说明3.png
因为IDEA生成注释的默认方式是：/* +模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为/*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）

IntelliJ IDEA方法注释模板设置说明4.png

*
 * description
 *       
 * @param:  $param$
 * @return $return$
 * @Date   $DATE$   
*/

设置参数的获取方式,选择右侧的Edit variables按钮
return返回脚本

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

设置参数的获取方式.png
直接下拉选择对应的属性
@params返回脚本

groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param ' + params[i] + '\\r\\n' : ' * @param ' + params[i] + '')}; }; return result;", methodParameters())

IntelliJ IDEA方法注释模板设置说明5.png
选择应用场景：勾选Java
IntelliJ IDEA方法注释模板设置说明6.png
选择快捷键,Enter = 回车用法： /** + 回车
IntelliJ IDEA方法注释模板设置说明7.png
效果图
IntelliJ IDEA方法注释模板设置说明8.png

IntelliJ IDEA方法注释模板设置说明