关于开发环境IDEA中类和方法的文档注释自动生成模板的设置

---

一、找到对应的设置位置

使用快捷键Ctrl + Alt + S或者在IDEA左上角的File按钮中点击Setting;

二、新建一个自己的模板组PersonalTemplates

三、新建自己的文档注释模板

关于类和方法的文档注释自动生成模板的代码如下：

1. 类的模板代码及配置过程

**
 * @Description : 
 * @Author : WhuLu
 * @Date : $data$ $time$
*/

按照上述图片进行配置：第一步，配置变量，如下图；第二步，配置使用场所，在列表中勾选java，如下图。


2. 方法的模板代码及配置过程
此处的代码不能加/，因为加过之后就查询不到参数名和返回值类型了，在使用快捷键的时候记得加上/就没有问题了

**
 * @Description :
 * @Params : $params$
 * @Return : $return$
 * @Author : WhuLu
 * @Date : $data$ $time$
*/

按照上述图片进行配置：第三步，配置变量，如下图；第五步，配置使用场所，在列表中勾选java，如下图。

• param中的Default value有时需要放入以下代码

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中的Default value有时需要放入以下代码

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

四、保存设置即可