嗨喽大家好,我是老黑,好久没创作文章了,今天整理一篇关于在IDEA中自定义注释模板的文章。
一、效果
直接看效果图,最终要实现什么。
就是在IDEA中创建一个方法前通过快捷键生成方法注释。
二、操作
1、打开IDEA找到File,点击Settings
2、创建一个注释组名
3、我这里就命名为test
然后再点击右上角的+号,这次选择Live Templetes
4、点击之后进入到下面的界面。
如上图所示,
第一个左边这个红色框中是输入这个值后,点击快捷键后自动生成注释,因为直接使用*号比较方便,就设置成星号,当然也可以设置成abc等等,根据自己的喜好来。
右边这个红色框中是这个说明这个注释是来干什么的。
蓝色框中的是你想要把注释模板设置成什么样。
绿色框中的是就是你想点击什么快捷键来生成注释。
5、这是我设置成的注释的模板。
*
* 方法描述:
* @author:
* @date: $date$ $time$
* $VAR1$
* $VAR2$
* @return: $return$
* @throws:
*/
6、这样设置后,$号中的参数是固定的,无法动态自动生成,需要设置一下。
如上图所示,点击右边的红色框,弹出自己设置的参数,参数的表示就设置成图片中那样。
date date()
time time()
VAR1 groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i!=0)result+= '* '; result+='@param ' + params[i] + ((i < (params.size() - 1)) ? '\\n' + '\\t' : ''); }; return result", methodParameters())
VAR2 groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i!=0)result+= '* '; result+='@param ' + params[i] + ((i < (params.size() - 1)) ? '\\n' + '\\t' : ''); }; return result", methodParameters())
return methodReturnType
7、点击apply,点击ok,然后再随便找个方法上面,点击/**+enter就可以了(我把快捷键设置成enter了)