IDEA类和方法的注释规范（超级实用）

1、类注释

先看效果显示

步骤非常简单，打开setting，找到File and Code Templates，找到class，直接复制这段代码

/**
 * @description: TODO
 * @author: qxq
 * @date: ${DATE} ${TIME}
 * @version: v1.0
 */

2、方法注释

最终效果如下：

设置方法：

1、同样也是打开setting，找到Live Templates，点击“+”号，创建组Template Group

2、输入组的名称，可以自行填写

3、选中刚创建的组，再点击+，在里面创建模板

4、按照下图进行操作。注意：可直接复制下面的代码(最前面没有“/”）：

**
 * @description: 
 * $param$
 * @return: $return$
 */

5、点击 Edit Variables

IDEA提供自带的methodParameters()和methodReturnType()方法，但并不是很好用，所以这里使用了大佬写的脚本，非常好用。

下面的脚本是我用过非常好用的脚本：

①param的脚本：每个参数单为一行，比自带的methodParameters()好用

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())

②return的脚本：可以自己选用return是否需要包名，还有返回值为void时不会报错（自带的methodReturnType()会报错）

显示包名的版本：

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

不显示包名的版本：

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

6、然后开始修改注释模板作用范围：

一般来说，直接选中Java即可，其他的不用勾选

7、到此就设置成功了，点击“OK”。在写好的方法上面，输入“//”，然后点击“Enter”，即可得到下图显示的效果

文中的脚本处自：IDEA类和方法注释模板设置（非常详细）_idea 类注释模板-CSDN博客

是黑taoA大佬写的脚本，自我感觉是最好用的脚本，所以记录下来，方便以后查阅