Idea设置：注释模板

一、前言

阅读了阿里巴巴java规范，里面有一则重要的就是注释规范，注释写好，犹如观看美女。所以，下面介绍idea怎么设置一键生成类注释和方法注释。

二、 类模板注释

操作步骤：

1. File–>settings–>Editor–>File and Code Templates–>Files
2. 选择Class文件（当然你要设置接口的还也可以选择Interface文件） ，添加注释模板如下：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
*@Author: shen
*@CreateTime: ${YEAR}-${MONTH}-${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version 1.0
*/
#parse("File Header.java")
public class ${NAME} {
}

二、方法模板注释

操作步骤：

1. File–>Settings–>Editor–>Live Templates
2. 新建组：命名为userDefine
3. 新建模板：命名为* ， 因为IDEA生成注释的默认方式是：/*+模板名+快捷键 。
4. 设置生成注释的快捷键 ：Enter

5. 模板内容-IDEA格式模板

*
 * @author: shen
 * @date: $date$ $time$
 * @description:
 * @param: $param$
 * @return: $return$
 **/

6. 选择右侧的Edit variables按钮 , IDEA格式的模板只需要为每个参数选择对应的方法即可

获取参数：

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

返回参数：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

7. 效果图