idea的方法文档注释模板

idea软件的方法注释模板

1.最终效果

  /**
   *
   *
   * @param strA
   * @param strB
   * @return java.lang.String
   * @author xxx
   * @date 2019/12/1 17:56
   * @since 1.0.0
   */
  public String test(String strA, String strB) {
    return strA + strB;
  }

2.实现

*
 * $END$
 *
$params$
 * @return $return$
 * @author xxx
 * @date $date$ $time$
 * @since 1.0.0
 */

上面是方法注释模板的内容。

params参数的表达式如下

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

3.最后使用

我这里方法注释模板的名称叫做mc，因此在使用时只需要在方法上输入 /*mc然后回车即可。
如：

注：如果出现的格式有点乱的话，可以选择在设置模板页面勾上Reformat according to style选项。