idea设置类注释和方法注释模板

冷不防 2021-09-26 10:46 609阅读 0赞

# 1、设置类注释模板 #

![这里写图片描述][a5f730fe985625d006eb4a54da61872d.png]  
这样在定义类时，都要多输入类的描述。不想的话，可以删去 **$\{description\}**

# 2、方法注释模板 #

## 先新建模板组，名字自己起。 ##

![这里写图片描述][97e8b3d05183c84559471f91e61b9455.png]

## 然后选中自己的模板组，在模板组下新建模板 ##

![这里写图片描述][16fd86f841ccc1529679bfb6f222995b.png]

## 如下图给模板设置信息 ##

![这里写图片描述][af656fcc0cab50db3fb77fa274e5a590.png]

## 1、设置模板名称，建议不要换，就是 \* 号，***注意：名称不能 / 开头，不然会导致获取params的 methodParameters() 等函数都失效*** ##

## 2、模板描述，可以没有 ##

## 3、模板，注意开头是没有 /\* 的 ##

*
     *功能描述 
     * @author qqg
     * @date $date$
     * @param $params$ 
     * @return $return$
     */

## 4、添加模板生成的地方，点开选择java或者全部都可以 ##

## 5、设置模板快捷键，我设置为回车 ##

## 6、编辑模板中的参数 ##

![这里写图片描述][609a79013ef5838326e1e107a07074de.png]

## 7、点apply完成 ##

## 8、用法：跟原来的一样： /\*\* + 回车 即可，这就是我为什么取名为 \* 的好处。 ##

# 4、细节修改 #

## 可以看到生成模板的参数时，不是很好，是数组的，要做一下修改 ##

## 1、模板改为: ##

*
     *功能描述 
     * @author qqg
     * @date $date$
     $params$ 
     * @return $return$
     */

## 2、添加 $params$ 参数分割 ##

![这里写图片描述][f053ad2630a490dee28e4edf7dce3ab1.png]  
即：

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

***注意：要是发现设置分割函数获取不到值，methodReturnType()等函数也获取不到值，请检查模板名称是否以 / 开头。以 / 开头就会导致函数失效***

--------------------

[a5f730fe985625d006eb4a54da61872d.png]: /images/20210923/aab554b7999746e1a8bd840c62115f64.png
[97e8b3d05183c84559471f91e61b9455.png]: /images/20210923/0192b66fcd1e4a81b238157869c27e2c.png
[16fd86f841ccc1529679bfb6f222995b.png]: /images/20210923/6f97d75657fa48d4b2f464a878483bb4.png
[af656fcc0cab50db3fb77fa274e5a590.png]: /images/20210923/cdb26c7946344af786b9f8aad0e664e0.png
[609a79013ef5838326e1e107a07074de.png]: /images/20210923/2ded735162dd46f08ae5a43644e1356a.png
[f053ad2630a490dee28e4edf7dce3ab1.png]: /images/20210923/07ea85460fb446faa3b21c87b83e2968.png