Idea设置Java类注释模板和方法注释模板
设置类注释模板
1）：选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
并勾选enable live template
注释模板：
1
2
3
4
5
6
7
8
| /**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author: runoob
* @date: ${date} ${time}
* @version: V1.0
*/
|
或自定义
1
2
3
4
5
6
| /**
* @Description: ${todo}
* @author: ${USER}
* @date: ${DATE} ${TIME}
* @version: V1.0
*/
|
设置方法注释模板
Idea没有可以直接设置方法注释模板的地方，可以借用Live Templates基本实现，步骤如下。
1）：选择File–>Settings–>Editor–>Live Templates，先选择右侧加号新建一个自己的模板组，如图 我这里命名模板组名为myGroup。
2）：选中组，选择右侧加号新建模板
这里注释快捷键可以自定义，如：cmj
3）：方法注释模板：
1
2
3
4
5
6
7
8
9
| /**
* @Title: $enclosing_method$
* @Description: $todo$
* @param: $param$
* @return: $return$
* @author: binge
* @date: $date$ $time$
* @throws
*/
|
4）：点击Define，勾选Java
5）：点击Edit variables编辑变量，设置如下，点击Ok–>Apply完成设置。
说明：实际上为$var_name$变量配置相应的Expression操作，如methodName()、date()等，用于生成指定注释内容
6）：输入“/**”或者自定义快捷键，如cmj，然后按Tab键即可生成注释。live这种方式是需要在方法内部生成，否则@param等一些参数会是null。不像eclipse 方法头部就可以。
自定义方法注释模板
template text
1
2
3
4
5
6
7
8
| /**
* @titile: $enclosing_method$
* @description: $todo$
$params$
* @return: $return$
* @author: dragon
* @date: $date$ $time$
*/
|
params
去掉params带中括号
1
2
3
4
5
| 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':'')};
return result", methodParameters())
|
retrun
去掉retrun全类名
1
2
3
4
5
6
7
8
9
10
11
| 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())
|
