IDEA中默认的方法注解模板往往不符合我们自己所需(输入/**然后回车后生成的方法注解),所以这时就需要按照我们的需求自定义一个模板,下面是我最常用的一种模板的配置方法。
1.进入到模板编辑界面
File > Setting > Editor > Live Templates
2.创建分组
点击标识[1]处,选择[Template Group]创建自己的模板分组,取名没有要求,我这里命名为Java
3.创建模板
再次点击标识[1]处选择[Live Template]选项创建模板
在标识[2]处为模板取名,我这里为了方便取名为**(注意这个名字是会被你自定义的内容替代的部分)
标识[3]处添加模板介绍
标识[4]处就是我们要自定义的模板,我的常用格式如下($符号包裹的是变量):
**
*
$params$
* @return $retuen$
* @author huicheng
* @date $date$ $time$
*/
4.定义模板变量
当第三部完成后,点击[Edit variables]按钮就可以看到我们之前定义的变量,这里我们将为变量匹配方法,在我们使用的时候就会动态生成信息,比如当前时间等等
IDEA自带的参数表达式[methodParametors()]返回的是一个数组,不符合我们的需求,所以需要自己来添加这个变量对应的表达式,返回我们需要的数据,下面这是一段用groovy语言写的脚本,将它复制到变量params的[Default value]当中:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '')return result;result+=' * @param ' + params[i] + ((i < params.size() - 1) ? ' \\n' : ' ')}; return result", methodParameters())
5.指定该模板的生效范围
单击标识[1]处修改该模板的应用上下文,可以选择Java,简单粗暴的选择[Everywhere]也是可以的
现在大功告成,在Java类的方法上输入 /**然后按Tab键就可以看到你自己定义的注释信息啦!