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

相关推荐
wangchunyu1143 小时前
JAVA CompletableFuture异步编程实战
java·开发语言·python
paopaokaka_luck4 小时前
流浪动物救助与收养系统(DeepSeek AI对话、 ECharts多维分析、救助流程衔接、领养与回访衔接、 捐赠确认与公示、志愿者协作)
java·前端·javascript·人工智能·mysql·echarts·推荐算法
Thomas.Sir4 小时前
第9课:SpringBoot4.x Web开发基础:WebMvc自动配置、静态资源、请求参数接收
java·spring boot
程序 代码狂人4 小时前
切片表与分区表的区别(数据开发面试版)
java·大数据·开发语言·数据仓库·算法
2501_944521595 小时前
Deepmerge 跨端三方库仓颉适配全流程
java·python·eclipse·github
南归北隐6 小时前
Spring AI Alibaba Graph框架实现MCP数据库查询实战
java·后端·spring ai·mcp·spring ai mcp
古法老登瞎折腾7 小时前
大数据智能运维实战(九):让 AI 查日志——找到异常,也保留上下文
java·大数据·运维·人工智能·spring ai·mcp
ai大模型-探索者7 小时前
Function Call与MCP(区别、联系与实战)
java·服务器·网络
略略略咯咯7 小时前
啊啊啊啊啊
java·服务器·数据库
SL_staff7 小时前
运维救火实战:钉钉API变更致薪资计算中断,如何用可视化逻辑引擎5分钟热修复
java·开源·全栈