IntelliJ IDEA 自定义方法注释模板

发布时间:2022-07-22 14:11:45 作者:yexindonglai@163.com 阅读(734)

前言

最近没啥事开始正式用Eclipse 转入 idea工具阵营,毕竟有70%的开发者在使用idea开发,所以它的魅力可想而知。刚上手大概有一天,就知道它为啥取名为 intelli(智能化)了,确实很智能,这还是一些小小的细节,当然idea也有它不足之处,就是我们今天要讲的“自定义方法注解模板”,类注解模板可以很简单的设置,这里我就不重复,而网上很多关于自定义方法注解模板的文章大多是抄袭获取转发根本自己就没有验证,本文经过自己亲自验证有效。

1、打开模板配置页

File->settings->Editor->Live Templates

2、添加模板组

点击右上角的绿色+号,然后选择template group ,然后输入group的name,随便输入就好了:myGroup。然后点ok

3、添加注释模板

选中刚才创建的myGroup,然后再次点击右侧的 +,这次选择的是第一个 Live Template。取名为*,取名可以随便,只是个人觉得方便,你可以取别的。

4、配置模板

下面是我自己使用的模板,大家仔细看我的模板开头是*而不是/*,这就是关键所在。

  1. *
  2. *
  3. * <TODO>
  4. $params$
  5. * @return $returns$
  6. * @author yexd $date$ $time$
  7. */

注意:只有当变量被$$包围时 右侧的Edit variables才可以点击哦。

5、配置变量

在编辑好模板之后就只为参数添加$$添加变量,点击右侧的 Editor variables,

在params 参数中加入以下代码,因为我们需要一行显示一个参数

  1. groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters())

6、完成、实验

完成之后点击Apply然后点击OK,注意了,重点的地方,在你的方法上输入 /*然后加上模板的名称*,这就是我为什么不取字母而取名为*,因为这样很快速,再按Tab键(注意啊不是按Enter键,而是按Tab键)就会出现你想要的注释了,很多教程是直接输入模板名称按tab键,但是这种方法的@param@return是获取不到的,再重复一遍正确的方式:/** 然后按Tab键;如果你取名为abc那就是 /*abc 然后按Tab。效果如下:

7、修改生成快捷键,将tab改为enter(回车)

另外,这个Tab是可以更改的,因为在eclipse上习惯了使用回车键来生成注释,所以只要在idea上的 Settings —> Editor —> Live Templates 中将By default expand with改成Enter即可

关键字idea