IDEA生成带参数和返回值注释

步骤说明

打开IDEA进入点击左上角 - 文件 - 设置 - 编辑器 - 活动模板

新建活动模板

填写模板文本

编辑变量

添加变量表达式

设置模板使用范围-设置全部范围应用-或者设置只在Java代码中使用等（看到最后）

打开IDEA进入 - 设置 - 编辑器 - 活动模板

1. 选择Live Template 新建一个模板---或者选择下面一个Template Group 新建一个模板组在这个模板组下面再次点击Live Template 新建模板、填写模板文本----模板文本如下（可自行增删改）：

   **
    * $param$
    * @return $return$
    * @date $date$ $time$
    * @description $description$
    */
   

1. 看图填空---缩写可自行定义这就是你调出这个注释的快捷键 , 我就按一般形式写的 ** , 这里我设置了参数、返回值、时间、描述四个值,模板文本上图已提供

1. 点击上图中的编辑变量

1. 其他的值对应的表达式照着填即可 , 以下是 return 、 param 的表达式（注意：上图中return表达式返回的是全类名导致返回值过长--不建议使用、下面已提供return的表达式）

• return表达式：

  groovyScript("
  	def result='';
  	def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList();
  	for(i = 0; i < params.size(); i++) {
  		if(i!=0){
  			result+='<';
  		};
  		def p1=params[i].split(',').toList();
  		for(i2 = 0; i2 < p1.size(); i2++)  {
  			def p2=p1[i2].split('\\\\.').toList();
  			result+=p2[p2.size()-1];
  			if(i2!=p1.size()-1){
  				result+=','
  			}
  		} ;
  	};
  	return result", methodReturnType())
  

• param表达式：

  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) ? '\\r\\n' : '')
      };
      return result", methodParameters())
  

• 显示效果：

  /**
   * @param （参数1）
   * @param （参数2）
   * (......)
   * @return 返回值
   * @data 时间
   * @description 描述
   */
  

现象一：IDEA提示悬空的注解

注释检查，可以通过以下方式禁用它：

1. 点击idea左上角文件->点击设置

2. 导航到编辑器 --> 检查

3. 在右侧菜单列表下，选择 Java --> JavaDoc---也可直接搜索 JavaDoc

4. 取消选中“悬空 Javadoc 注释”

现象二：IDEA提示标签说明已丢失

注释检查，可以通过以下方式禁用它：

1. 点击idea左上角文件->点击设置

2. 导航到编辑器 --> 检查

3. 在右侧菜单列表下，选择 Java --> JavaDoc---也可直接搜索 JavaDoc

4. 取消选中“声明有 Javadoc 的问题”

使用范围设置

记得选择注释使用范围---一般直接选择全部或者选择Java即可 , 方便又省事。也可以根据需求自行选择使用范围

最后点击 应用 、确认 就可以了。

注释使用

来到需要注释的 方法上 输入 /** 点击回车即可调出刚刚设置的注释

以上是根据我自己的喜好来设置的看着也还行、对于那些怕麻烦的朋友们就直接按着步骤来即可无需过多的设置

如果想要其他注释效果的在这基础上稍加修改即可。表达式也比较简单 , 看一下修改的地方也就是if判断和返回值了

以上方法本人亲测有效、没达到效果的伙伴们可以评论区留言解答