网上有很多类似的文章,但是我在按照他们的文章设置后,出现了一些问题,因此我这边在解决了问题后,总结一篇文章,发出来给大家借鉴一下。在此先说明一下idea的版本,是2020.1.3
设置动态模板,File->Settings->Editor->Live Template
点击右上角的+号,添加动态模板组Template Group,再添加动态模板Live Template
abbreviation意为缩写,如我们设置为testmc。
模板文本template text如下:
*
* @author your name
* @date $date$ $time$
* @description $description$
* @param $params$
* @returns $returns$
**/
编辑动态注释要使用的地方
只选择Java相关的
点击右侧的edit variables,值的表达式可以使用idea自带的模板,也可以使用groovy表达式
注意,使用方法注释的方式是 /*+动态模板缩写(testmc)+Tab
[2,4]。之前我一直以为直接使用缩写,导致param和return无法识别。这个是使用动态模板后的效果。
但是在对于方法列表有多个入参的时候,idea自带模板methodParams()不尽如人意,无法对每个参数分别使用一行进行说明,
可以看到param那里还是有一些不尽如人意,我们可以用groovy表达式改进一下。
方法模板改为
*
* @author your name
* @date $date$ $time$
* @description $description$
$params$
$returns$
**/
edit vatiables中,param和return值依次如下[1]:
param
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ' ' +((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : result", methodParameters())
return
groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' ';}", methodReturnType());
注释效果如下,可以看到对于方法列表有多个入参也能有比较好的效果:
模板文本这部分设置是你期望的注释格式,诸如$date$
是能被idea识别的占位符,在右侧的edit variables中能够编辑这些占位符对应的值。不过在具体的使用中,使用idea自带模板和groovy表达式的时候,模板中是否带有@param@return,是有细微的区别的,这一点读者可以自行验证。
参考文章:
[1],IDEA设置方法注释模板
[2],idea设置方法注释(亲测有效)
[3],IDEA设置自定义注释快捷键
[4],超级详细的IDEA设置Java类和方法的注释模板