该博客仅用于分享个人自觉比较好的一个自动生成注释的配置,在最后也有分享一些大佬很好的配置。
1、生成方法注释的展示效果
先看效果:
接下来开始配置: File->Settings
2、先添加Template Group
3、给这个Group生成Template
4、编辑生成的注释样例
下面是我的一些配置:
**
* <p>
* description:
* </p>
*
$params$
* @return: $return$
* @author: bluefoxyu
* @date: $time$ $date$
*/
5、配置Edit variables
下面给出params,time,date的配置项信息:
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())
date("yyyy-MM-dd")
date("HH:mm:ss")
6、选择注释触发条件
7、选择应用于Java
8、推荐参考大佬的配置方法
很详细,在自己配置的时候参考了下面这些大佬的博客,总结了一个简洁和自己喜欢的版本
IDEA 中自定义设置类注释和方法注释(详解)_idea类注释-CSDN博客
IntelliJ IDEA中设置自动生成Java类注释、方法注释(以及处理param数组问题)_idea方法注释param-CSDN博客