IDEA类与方法注释模版设置-史上最牛逼的最规范的样式

序言：

当前网上有很多IDEA注释模版设置的文章，但是他们都存在一个问题，没有与阿里代码规范相结合，导致配置模版后，在代码里出现了大量的黄色的提示线，对于有代码洁癖的工程师来说，这是完全完全不被允许的。

正文：

首选给大家看下配置模版后的注释样式，然后再告诉大家如何配置

类注释

方法注释-返回值

方法注释-无返回值-有参数

 在方法注释里还可以加 @version 版本号等信息

那么如何配置呢：

类注释配置路径：IDEA ->Preferences -> Editor -> File And Code Templates 下的，例如如下图

 

分别点击Class 、Interface、Enum类型，在又侧的框中填入

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
  *
  *The {@code ${NAME}} class
  *
  *@author Mr Zan
  *@since ${DATE} ${TIME}
  *Copyright is 你的公司名称
  */
public class ${NAME} {
}

在右下方的Description中会有支持的变量名称，例如 ${PROJECT_NAME}  是项目名称 

${NAME} 是类名称、 ${USER}是当前系统的登陆名，我没用${USER}的原因是登陆名看起来不美观，大家可以试试，大家可能注意到时间为啥不用 @date呢？？应为系统不识别该变量，而且我们在查看源码的时候，也没有@date 这个名称，所以我这里用的@since来接收日期，还有一些其他的变量，如日期之类的、包名等等。

配置完成后点击最下方的Appy应用即可，然后咱们在配置方法注释

方法注释配置路径：IDEA ->Preferences -> Editor ->Live Templates

如下图所示：

按照下图顺序点击：

当我们选择上上图4的步骤后，会出现下面的图

特别注意：

在1的位置，我们可以随便定义一个快捷键名称，这里不建议定义成*之类的，容易与注解本身的*号混淆，这里可以定义容易记的，例如method 、me 或者其他的，大家根据自己的喜好定义即可。

2的位置是我们方法的模版

**
 * <p></p>
 * $param$ $return$
 * @author Mr Zan
 * @since $date$ $time$ 
 */

大家可能注意到，模版的开始缺少“/”字符，是因为我们在使用的时候要通过 / + 快捷键名称来调出方法模版的。

在<p>标签内部大家编写对该方法的解释，例如该方法是干嘛的，或者写上该方法的执行的顺序，这样有利于自己及其他接手的同学方便阅读代码的业务逻辑。

这里的变量名称 param、return、date、time，这些变量都要在上图3中进行编辑。

如下图

IDEA中会内置一些变量，如 时间，还有一些是需要我们写脚本来获取的

方法的参数 param

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

 返回值return

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

最后一个Skip if defined选项，如果我们不勾选的话，在实际使用中，光标会停留到变量的后面，等待你输入，通过enter键来切换到下一个待输入的变量的位置，我们这里勾选，通过在方法注释生成后，再手动将鼠标移动到需要二次编辑的注释的某个位置，最后点击OK按钮 、apply、OK按钮。

大家快去试试吧，如果有更好的模版内容，欢迎下面留言。