Mac/Windows上idea的方法注释模版配置-全场景参数和返回值处理

前言

网上很多idea方法注释模版配置教程，但多是复制粘贴的。我找了几个教程配置发现多多少少有点小问题。所以，特地学groovy语法后，对网上的参数和返回值处理实现进行了优化。优化后的实现逻辑，可适用于无参/单参/多参，无返参/有返参等全场景的处理。

1 新增Live Templates

具体操作不做赘述，大致步骤如下：

Preferences > Editor > Live Templates > 新增或选择已有的Templates Group > 新增Live Templates

2 配置Live Templates

2.1 配置Abbreviation

* // 可自定义，生成注释时 该字符串 会被 Template text 替换掉

2.2 配置Description

Java method annotation // 可自定义

2.3 配置Template text

*
 * 描述: 
 $param$$return$
 * @author AceChen
 * @date $date$
 */

注意：$param$$return$部分必须按照此格式配置，否则会在生成注释时出现参数/返回值格式异常的情况（因与下面的param/return配置相关）；其他部分可自定义。

2.4 配置Template Variables

• param：参数处理，适用于无参、单参、多参

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

• return：返回值处理，适用于无返参、有返参

  groovyScript("def returnType = \"${_1}\"; return ('void' == returnType ? '' : '\\r\\n * @return ' + returnType + ' ');", methodReturnType());
  

• date：日期处理

  date()
  

2.5 配置Applicable

3 使用方法注释

3.1 快捷键

/* + *(或自定义的Abbreviation) + tab

注意：按此快捷键后，用鼠标点击空白处（最好是点击‘描述:’后，顺便写上方法描述），不要按enter(win)/return(mac)/tab键（多参时按这三个键会使参数缩进错误）。

3.2 效果示例

最后，希望这篇文章对你有所帮助。