IDEA 自动生成方法注释

该博客仅用于分享个人自觉比较好的一个自动生成注释的配置,在最后也有分享一些大佬很好的配置。

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博客

IDEA给【类】和【方法】设置作者和日期等注释(适合初学者)_idea设置作者和日期等注释-CSDN博客

IDEA 自定义注解(类注释、方法注释)_idea自定义注释-CSDN博客

相关推荐
被摘下的星星2 分钟前
Java 中 .length、.length() 以及 .size() 的区分
java·开发语言
代码不停7 分钟前
子数组问题
java·算法
信誓旦旦的程序猿22 分钟前
【零依赖量化数据实战 #25】北交所技术指标与基本面
java·人工智能·python·股票数据api·股票数据·股票数据api接口·股票api数据接口
万年咸鱼26 分钟前
Java ArrayList 详解:原理、用法与实战
java·开发语言·windows
CoderYanger1 小时前
A.每日一题:3345. 最小可整除数位乘积 I
java·数据结构·程序人生·算法·leetcode·面试·学习方法
小刘是地理大王1 小时前
OpenFeign 兜底回调(fallback / fallbackFactory)实战指南
java·后端
橘子汽水1681 小时前
Leetcode15:三数之和
java·数据结构·算法
Nolla1 小时前
为什么 assertThrows 需要 () ->:Lambda 延迟执行与异常捕获
java
SL_staff1 小时前
风控规则不该写代码:一个开发者视角的规则引擎实践拆解
java·架构·全栈