idea生成类模板和方法模板（超详细）

​ 当我们使用idea工具进行代码开发的时候，注释是必不可少的东西。但是总是重复的写注释或者粘贴注释，不但麻烦，而且浪费时间。那么，能不能在写代码的时候，自动生成注释或者用很少的步骤，就可以调用注释呢？当时可以的了。先展示一下效果图，如下图：

一、配置类注释模板

1.点击File–>setting进入设置页面，如图一，也可以通过快捷键Ctrl+Alt+S进入设置页面；

2.打开Editor–>File and Code Templates标签，点击右侧的Class标签，在Class标签右侧的public class ${NAME}上输入自己想要类的注释模板，如图二；其中$DATE表示日期，格式和系统的短日期格式保持一致；$TIME$表示时间，只显示到分钟。

完成之后的效果图三

模板如下：

/**
 * 
TODO
 *
 * @author chaomeng
 * @version V1.0.0
 * @date ${DATE} ${TIME}
 */

可以根据自己的需求进行一些修改和变化，idea工具本身还提供另外的一些取值函数，例如获取包名${PACKAGE_NAME}，详情见图二右下角的Description标签，下图也展示了部分，可以根据自己的需求到idea工具内查看详细。

另外，配置interface和enum同理，可以根据自己的需求进行配置。

二、配置方法注释模板

1. 配置方法注释模板和类基本相似，进入File–>setting–>Editor–>Live Templates标签，点击右边箭头处的+符号，如图五；

2.如图六，先创建Template Group，命名为MyTemplates；在点击Live Template按钮，创建方法注释模板；

3.在创建Live Template时，Abbreviation一栏输入*，Description一栏根据自己需求书写，Template Text的内容如下：

**
 * <p>TODO</p>
 * $param$ $return$
 * @author chaomeng
 * @date $date$ $time$
 */

4.默认的触发方式在方法上输入/*后点击tab键修改即可，也可以在右侧的修改出发方式处修改；下侧的修改适用范围是选择该模板的使用范围，我一般选择适用Java；

5.修改变量，上图的变量定义中的变量就是$date$中定义的变量，可以根据自己的实际需求修改。

6.可以通过下拉框选择默认函数，如date变量选择了date()函数，time变量选择了time函数；

7.param和return变量使用的groovyScript脚本对格式进行了调整，具体的脚本如下：

param参数脚本：

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

return参数脚本：

groovyScript("def returnType = \"${_1}\";if(returnType=='null'||returnType=='void'){ return;}else{return '\\r\\n'+' * @return {@link ' + returnType+'} TODO';}", methodReturnType()); 

如果有其他的需求，可以自行调整上面的groovyScript脚本。

8.在以上都做好了之后，还有一点点瑕疵，注释生成的同时还会出现如下图的红色方框，还会导致格式错误。那么解决方案就是如图11一样，把skip if defined全部勾选上即可。

以上，就是我配置idea的类注释模板和方法注释模板的方法，希望可以帮到你！！！