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

相关推荐
日月云棠几秒前
12 Enum —— 枚举类型的底层实现
java·后端
轻刀快马6 分钟前
从繁琐到极简,从幻象到本质:Spring AOP 架构演进与实战避坑指南
java·spring·架构
weixin_BYSJ19876 分钟前
springboot旅游管理系统04470(附源码+开发文档+部署教程)
java·spring boot·python·算法·django·flask·旅游
8Qi89 分钟前
LeetCode 209. 长度最小的子数组(Minimum Size Subarray Sum)
java·算法·leetcode·双指针·滑动窗口
方也_arkling11 分钟前
【Java-Day12】接口
java·开发语言
SimonKing12 分钟前
Java程序员接入AI的另一种姿势:LangChain4j
java·后端·程序员
vensli25 分钟前
消息跨端架构演进:基于 C++ 的多端一致性研发框架实践
java·人工智能·软件工程·安卓
云烟成雨TD25 分钟前
Spring AI Alibaba 1.x 系列【70】思考模式
java·人工智能·spring
逸Y 仙X25 分钟前
文章六:ElasticSearch 集群通信安全权限
java·大数据·服务器·elasticsearch·搜索引擎·全文检索
瑞雪兆丰年兮34 分钟前
[从0开始学Java|第十六、十七天]项目阶段(拼图小游戏)
java·开发语言