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

相关推荐
plainGeekDev1 小时前
单例模式 → object 声明
android·java·kotlin
用户298698530142 小时前
Java 实现 Word 文档文本与图片提取的方法
java·后端
SimonKing3 小时前
铁子,IntelliJ IDEA 2026.1.3来了,升不升?
java·后端·程序员
咖啡八杯14 小时前
GoF设计模式——策略模式
java·后端·spring·设计模式
用户128526116021 天前
我把祖传Java项目重构后,接口响应从3s砍到了200ms,只改了这几行代码
java
Linsk1 天前
组件 = 模板 + 业务逻辑
java·前端·vue.js
星沉远浦1 天前
用Gemini高效解决Java代码报错难以定位的问题
java
用户298698530141 天前
Word 文档字符级格式化:Java 实现方案详解
java·后端
笨鸟飞不快1 天前
从单个服务到集群:一次完整的性能排查复盘
java·前端