记录idea注释模板的配置

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

前言

提高代码开发速度和质量，定义注释模板并快速输出注释提高开发效率。

---

一、类注释

类注释模板：
1、File–>settings–>Editor–>File and Code Templates–>Files
点击列表中的class，右侧出现输入框把代码模板粘贴进去，保存就可以了。

/**
*@PackageName: ${PACKAGE_NAME}
*@Author: liuyihsuai
*@CreateTime: ${YEAR}-${MONTH}-${DAY}  ${HOUR}:${MINUTE}
*@Description: 
*@Version: 1.0
*/

@PackageName：当前包的名称

@Author：开发者的名字

@CreateTime：该类创建的时间

@Description：对该类的描述（该类的功能）

@Version：设置版本号

二、方法注释

1、File–>Settings–>Editor–>Live Templates

这里的abbreviation 不能用带/，会导致注释加载出来的param和return是null

**
 * @description:
 * @author: liuyishuai 
 * @date: $date$ $time$ $param$ $return$
 **/

模板粘贴进去后设置一下param和return的取值，默认的取值不太好用。

param

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

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

配置好之后输入/*然后回车就实现了。

总结

学习使我快乐。