“王哥，王哥，代码又冲突了！”

“王司，王司，代码咋拉下来冲突了！”

血压瞬间飙升

走近一看，原来是代码注释的不一样，导致了代码冲突，我的血压就如上图一样。

自从到新公司后，这样的场景已经上演过很多次了。在多次”血淋淋的”事情发生后。终于在上周五，我们下定决心，要统一下代码的注释模板。解决这让人蛋痛的问题。

首先介绍下：我们使用的开发工具是大名鼎鼎的 “IDEA”。

言归正传，开始来介绍设置方法：

类、接口、枚举、注解的注释模板

• 打开idea的设置界面快捷键Ctrl+Alt+s或者 在导航栏中File->Setting

• 选择Editor->File And Code Templates；如下图所示，打开其中一个看到又一句话 #parse(“File Header. java “）; 此时有两种设置方式。一种是删除 #parse(“File Header.java”), 直接在此处添加类、接口、枚举、注解的注释；另一种是在Includes页签下找到File Header 文件，如果没有可以自己创建该文件，然后将我们的注释模板粘贴进去。

示例图

 我的注释模板      
/**
  * @author $user$
  * @ClassName ${PACKAGE_NAME}.${NAME}
  * @Date ${DATE} ${TIME}
  * @Version V1.0
  * Description  <请输入一句话描述该类功能>
  * Copyright (C) XXX公司  since ${DATE}
*/  

• 效果如下所示

效果图

方法注释模板

• 打开idea的设置界面快捷键Ctrl+Alt+s或者 在导航栏中File->Setting
• 选择Editor->Live Templates，选择新建一个Temlate Group，
• 选择新建好的template group，新建一个Live Template，有如下四点需要我们编写的

1. abbreviation——缩略语。指使用该模板的快捷方式，这里我们设置为*
2. description——描述信息。该模板的描述信息
3. Editor variables——编辑模板中的变量信息，等会儿会重点讲解这里。
4. Expand with——以什么方式展开模板内容，这里我们使用默认的。

示例图

 我设置的注释模板
*
 * <描述方法功能>
 * <方法详细功能>
 * @Author $user$
 * @Date $date$ $time$
   $param$  
 * @return $return$
 **/  

点击Editor 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())  

设置好的效果图如下：

最终效果图

PS：不知道是不是因为版本的问题，方法注释的 abbreviation只能写 * , 写成 /** 读取参数的 groovyScript就无法起作用了。有没有大佬知道的？