二、类和方法的模板注释

二、类和方法的模板注释

---

2.1、修改类注释模板

在File->Settings->Editor->File and Code Templates下分别修改Class，Interface，Enum等注释模板，Class模板部分修改如下，其余的举一反三进行修改。以下所示的${DESCRIPTION}是自定义变量，会在创建类时请求输入

 /**
  * Copyright (C), 2015-${YEAR}, XXX有限公司
  * FileName: ${NAME}
  * Author:   ${USER}
  * Date:     ${DATE} ${TIME}
  * Description: ${DESCRIPTION}
  * History:
  * <author>          <time>          <version>          <desc>
  * 作者姓名           修改时间           版本号              描述
  */
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")
    package ${PACKAGE_NAME};
#end

/**
 * 〈一句话功能简述〉<br> 
 * 〈${DESCRIPTION}〉
 *
 * @author ${USER}
 * @create ${DATE}
 * @since 1.0.0
 */
public class ${NAME} {

}

2.2、方法注释模板修改

在File->Settings->Editor->Live Templates下添加自定义Template Group，并在自定义Template Group下添加自定义Template

具体配置如下：

Template text内容如下:
/**
 * 功能描述: <br>
 * 〈$END$〉
 *
 $param$
 * @return:$return$
 * @since: 1.0.0
 * @Author:$user$
 * @Date: $DATE$ $TIME$
 */

Edit Template Variables请求参数部分内容如下:
　　这个是param这个参数名的Expression:
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())

完成如上配置后，只需在方法内执行/**+Tab键即可生成注释，切记这里说的是方法内部，因为methodParameters()的作用域只在方法内部，这也是Intellij IDEA比较蛋疼的一点。

2.3、生成序列化代码

勾选Setting->Inspections->Serialization issues->Serializable class without ’serialVersionUID’