IDEA方法注释模板设置

说明

IDEA的方法注释配置不好弄,网上找了没几个能用的,下面是自己配成功的,记录下,不做详细步骤说明。

效果图

IDEA方法注释.gif

步骤

  1. 自定义模板,新建一个方法注释模板


    图一
  2. 在Template text写入如下脚本,格式需与图中标注的相同
*
 * $comment$
 * @author Your name
 * @created $date$ $time$
 * $VAR1$
 $params$* @return $returns$
 */
  1. 点击Edit Variable,给模板变量写入表达式
    图二
  2. VAR1变量的详细脚本如下:
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)) ? '\\n' + '\\t' : '');   
    };    
    return result", methodParameters())

参考

idea自动生成方法注释(含参数及返回值)

你可能感兴趣的:(IDEA方法注释模板设置)