IDEA注释模板配置

  最初，从Eclipse转到IDEA，总是不习惯IDEA的注释方式，所以在网上找来找去加上自己的测试，终于形成一套相对详细的配置流程。之前每次用到都靠收藏里的别人文章应付，但是在配置新的开发环境或者有新的小组成员加入时总要用到，为了方便，将内容整理后放到这里。

• 一、配置类注释模板
• 二、配置方法注释模板

1. 说明：IDEA在创建类时根据各类文件模板创建，因此在类模板里设置了类注释，新增类文件时回自动添加自定义的注释；
2. 操作路径：File–>settings–>Editor–>File and Code Templates，具体步骤：
   a）Files 标签中是文件类型，通常关注的是Java相关的Class、Interface、Enum等文件，选择文件后，可看到如下内容，其中"File Header.java"对应 Includes 标签中的内容，表示该文件模板包含了“File Header.java”：

   #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
   #parse("File Header.java")
   public class ${NAME} {
   }
   

   b）因此，通常情况下，我们可以直接修改Includes标签中的“File Header.java”文件，除非对不同类型文件有个性化定制，按个人习惯，我的文件内容修改如下：
   c）其中，用到了TODO待办标记、@Description描述、@Author作者、@Date日期等定义，还可以加入@ClassName、@Version等；
   d）修改完后，点击“Apply”按钮使之生效即可。
   

1. 说明：使用Eclipse时我们生成注释的习惯是

   
   5）设置模板的应用场景，一般设置为EveryWhere–>Java即可，如下图：
   
   6）设置参数的获取方式，选择右侧的Edit variables按钮，如下图：
   
   7）参数param、return的Expression和Default value如下：

   // param和return的Expression
   annotated("annotation qname")
   
   // param Default value
   groovyScript("if("${_1}"=="null"||"${_1}".length() == 2) {return '';} else {def result=''; def params="${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='\n * @Param ' + params[i]}else{result+='\n' + ' * @Param ' + params[i]}}; return result;}", methodParameters());
   
   // return Default value
   groovyScript("if("${_1}"=="null") {return '';} else {def returnType = "${_1}"; def result = '\n * @Return ' + returnType; return result;}", methodReturnType());
   

   8）设置完毕，点击“Apply”按钮使之生效即可。