我们在使用idea的过程中有时候会使用快捷键给类、方法或者属性添加注释,这时候就可以用自定义注释模板的方法去配置。
1.点击File->Settings,如下图:
2. 搜索框输入:Live Templates ,选择后,右边是已经存在的模板。点击+号,选择2.Template Group 可以创建自己的模板组。如下图,按照序号顺序操作即可。
3.按照上图步骤操作完成后,需要输入自定义的一个模板组的名称,如下图:
输入名字后,点击ok按钮即可。
4.选择新建的模板组的名字,然后右边点击+号,选择1.Live Template添加该组的模板,如下图。
5.上一步操作完成后,看下图:
按照图片上红框的内容去填写,我这里用的方法的模板内容如下(可以根据自己的需要修改):
**
* 方法描述:
* @Author loveycgg
* @Date $date$ $time$
$param$
* @return $return$
**/
$***$这个结构就表示是变量的占位符,这些变量需要在上图中的Edit Template Variables中做出配置。
其中param的表达式如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); result+='* @param ' + params[0];for(i = 1; i < params.size(); i++) {result+= '\\n' + ' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
6. 确定模板应用的位置,点击Define,选择Java打勾,然后点击Apply 点击OK关闭窗口即可。
7. 在文件中使用时,只需要输入/*然后回车即可快捷使用注释模板生成注释。
总结:自定义模板可以定义多个,使用不同的简写即可,简写实际就是使用时候的快捷键,你简写写什么,使用的时候就用/简写+回车即可。如果不想用回车键也可以在上图右下角的Options-->Expand with的下拉选项中选择别的触发条件。