idea中自定义注释模板

idea中自定义注释模板

一、方法注释

1. 创建模板组

选择红框中的 Template Group... 创建一个分组

2. 创建模板

选择 Live Template 创建模板

• 使用模板的快捷方式： *** 的意思是在方法上方 输入 /*** 敲击回车即可使用模板

• 模板内容

  **
   * ...None
   * $params$
   * @return $returns$
   * @author mahy, [email protected] <br>
   * created at $date$ $time$ 
   */

• Change 如果没有选择显示的不是 change ， 而是 Defin... 忘了，意思是适用于 java 文件

  

• Edit Variables... ： 是给模板内容中的参数设置表达式

  

  • params 的 default value

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

  • returns 的 default value

    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()) 

• 设置使用模板时敲击的按键

  

• 测试的东西，根据自己的需要选择框中的选项

  

3. 使用模板

在方法上方输入 /*** 敲击回车

即可出现注释

二、类注释

避免麻烦 统一使用文件头部注释

注释内容：

/**
 * <h3>NOTE</h3>
 * <p>
 *   ...None
 * </p>
 * @author mahy, [email protected]
 * <p>${DATE} ${HOUR}:${MINUTE}:${SECOND}</p>
 */