IDEA简单好看实用的注释模板

 IDEA配置注释模板

---

一、配置类注释模板

1、File → setting...  →  Editor  →  Live Templates，如下图所示：

2、点击右侧 + 号，选择创建模板组，并输入模板的名称，具体如下图所示：

3、选择刚刚新建的模板组，点击右侧 + 号，创建新模板，具体如下图所示：

4、配置模板快捷键、配置模板内容，点击Define，会出现列表，选择Java。具体如下图所示：

/**
 *  @author: xingming
 *  @Date: $Date$ $time$
 *  @Description:
 */ 

5、配置变量属性值：

6、依次点击OK完成配置，使用时，在类的顶部输入/**，点击回车（Enter）,就可以调出注释。

---

二、方法注释配置

1、选择刚刚新建的模板组，点击右侧 + 号，新建模板。具体如下图所示：

/**
* @Description
* @Author  xingming
* @Date   $date$ $time$
 $param$
* @Return      $return$
* @Exception   $exception$
* 
*/

2、点击下方Define，选择Java。具体如图所示：

3、配置变量属性值：

4、依次点击OK，完成配置，使用时，在方法顶部，输入/*，点击回车（Enter）,调用注释。

 

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' : '')}; return result", methodParameters())