IDEA中设置注释模板的方法

IDEA中设置注释模板主要分为两个部分，分别是创建java文件时类的注释和方法的注释。

一、设置类的注释模板

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时的注释模板

 

二、设置方法的注释模板

1、选择File→Settings→Editor→Live Templates。点击右边的加号，选择Template Group，创建一个分组

 

2、再点击加号，选择Live Template，创建一个模板。其中：

Abbreviation：填模板的缩写，可以使用*号作为代号，方便后面调用模板。

Options→Expand with：填注释模板的扩展快捷键，根据使用习惯，这里使用Enter。

Template text：填写注释模板的内容。参数名使用${参数名}$的格式。

* 
 * <p>
 * <code>$method$</code> $describe$
 * </p>
 *      
 * @author $user$
$param$ $paramdscb$
 * @return $return$ 
 */

 

3、点击模板页面最下方的警告define，来设置将模板应用于哪些场景，选择Everywhere-->Java即可。（如果曾经修改过，则显示为change而不是define） 

4、然后点击Edit variables，会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。

5、参数赋值优化

（1）如果param参数使用默认的methodParameters()来获取方法参数值，其注释参数是在一行展示的，如上图。这里我们希望像MyEclipse中一样，一行一个参数的样式，可以通过脚本来实现。将以下脚本复制进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) ? '\\r\\n\\t' : '')}; return result", methodParameters())

 （2）如果return参数使用默认的methodReturnType()来获取参数值，模板里使用了@link来跳转结果类型，那么当方法返回值为void时，注释会报错，如上图。可以通过脚本来避免，将上面模板中的@link参数去掉，将以下脚本复制进Expression：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())