Idea 设置类和方法的快捷注释(2020-6-4亲测有效)

写代码加注解是一个程序员的基本习惯，一是为了以后自己能看得懂，二是为了别人看自己代码时能看得懂，同时也为了方便阅读，那么idea怎么设置类和方法的快捷注解呢？接下来我们就详细讲解一下。
本文是为了记录一下以防以后忘记，因为之前找了很久都没找到好的，总结很多博客和文章才找到一个能用的，所以记录一下，希望对你也有用。废话不多说，下面开始

1、先设置类的注解，打开idea，进入设置界面

将下面的内容放在右边的方框内

/**
 * @Description:  ${description}  // 类说明，在创建类时要填写
 * @ClassName:      ${NAME}    // 类名，会自动填充
 * @Author:  weisn          // 创建者
 * @Date:    ${DATE} ${TIME}   // 时间
 * @Version:    1.0     // 版本
 */

这是我设置的内容，大家可以网上找一下更全面的，或者自己添加自己想要的内容。 然后保存就可以了，下面我们新建一个类来验证一下成不成功。

看来上面的类设置测试是成功的，下面我们来设置方法的注解设置

2、打开设置，按照下面步骤新建一个组

输入组名，随便输入

将 Abbreviation: 的值改成 *

在上图的方框内输入以下内容：

*
 *  $TODO$
 *
 * @author weisn
$param$ 
 * @return $return$
 * @date $date$ $time$
 */

记住开头是一个 * 而不是 /* 很多帖子都是 /* ，这里是一个 *

然后点击 Edit variables，在弹出的弹窗填如下内容，记住param的内容如下

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

一定要一字不落的复制进去

然后点ok

下一步修改下图中底部红色字体 No applicable contexts yet. Define ，点击 Define 打开后，设置如下：

到这里就结束了，最后要讲的一点是下面这两个地方的设置，我这里用的是回车，你可以选择tab或者其他的，然后保存就可以了

下面我们写一个方法，然后来验证一下。在方法的上面输入/**然后回车

看来是成功的，这是我idea设置类和方法的注解的方法，不知道对你有没有用，我目前idea的版本是2020.1.1的，之前的应该也可以，好的到这里就结束的，谢谢大家，我是叶虽

做一下调整：

*
 * $TODO$
 * @author weisn    $param$
 * @see $return$
 * @date $date$ $time$
 */

方法参数代码：

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

方法参数的代码非常重要，一点要复制完整
更新时间：2022年5月20日15:49:01