idea类和方法注释模板设置

1.创建类注释模板

创建类/接口/枚举 自动添加注释

/**
  * 类说明：
  *
  * @ClassName ${NAME} 
  * @Author sunyh
  * @Date ${DATE} ${TIME}
  * @Version 1.0
  */ 

2.创建方法注释模板

位置：File---Settings---Editor---Live Templates

点击右侧的“+”，选择“2.Template Group”，新建一个模板命名为methodTemplates，点击OK。

 

 

然后在建立好的methodTemplates模板上点击右侧的“+”，新建一个“1.Live Template”：

在③处输入模板的简写码：*

在④处输入方法的描述：add Comments for method

在⑤处输入注释模板代码

**
 * 方法说明：
 *
 * @MethodName $title$
 * @Description $description$ $param$ $return$ $throws$
 * @Author sunyh
 * @Date $date$ $TIME$  
 * @修改人及日期：
 * @修改说明：
 */

点击⑥对变量进行编辑，参数设置如下：

其中： 

param代码：

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

 return代码：

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

记得给右边的方框打勾，点击OK完成参数设置。

接下来设置该模板的作用范围，该位置首次设置是为Define，修改后设置时变为Change，可设置为Everywhere，表示任意位置都可以添加。

点击右下方Options中的Expand With可设置配合使用的快捷键，有Tab、Space、Enter等，如果上面设置的模板关键词为*，此处可默认使用Tab作为快捷键。

 

给类中方法添加注释时，输入/*，然后按Tab完成注释添加