idea类注释模板
在创建类的时候直接生成类注释
两种方法:
- 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Includes–>File Header
- 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Files–>Class
输入类注释代码(按照自己需求来即可):
/**
* @author ${USER}
* #Description ${NAME}
* #Date: ${DATE} ${HOUR}:${MINUTE}
*/
效果如下:
idea方法注释模板
在idea中是没有直接生成方法注释的快捷键的,我们可以通过psvm、sout等类似快捷方式生成模板
首先,依次打开File–>Settings–>Editor–>Live Templates
然后,点击右边的”+“号,选择Template Group,创建自定义的新组,如下图所示:
选择自己的组名,点击”+”号,选择Live Template,创建新的活动模板,其中Abbreviation输入自定义的快捷字(图中为add),类似于psvm、sout,使用时输入他加上Tab键即可,如下图所示:
Template text中需要填写模板代码:
/**
* #Description $description$
* @param $params$
* @return $returns$
* @author feizhen
* #Date $date$
*/
不过最好不要这么写,因为直接使用add+tab方式是无法在方法外面获取方法参数的,只能在方法内部获取
为解决此问题,可以在/*
后面输入add
(自定义),之后按Tab键
此时,模板代码应改写为下图所示(因为前面已有/*了)
*
* #Description $description$
* @param $params$
* @return $returns$
* @author feizhen
* #Date $date$
*/
之后,点击Template text下方的Define,按需求选择,一般选择java即可
只有第一次会出现Define,如果是想修改,可以右键点击模板名,选择Change context,如下图所示
最后,编辑变量,获取参数。如下图所示:
演示过程如下:
按下Tab键
可以发现,此时注释中的@param参数会被[]包起来,产生报错,对于此情况,我们可以使用脚本,不再使用idea自带的方法
脚本如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') continue;if(i==0) result += params[0]+((params.size()==1)?'':'\\n');else{ result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}}; return result", methodParameters())
最终效果: