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

相关推荐
Lhappy嘻嘻1 小时前
Java IO|File 文件操作 + 字节流 / 字符流完整笔记 + 递归删除文件实战
java·笔记·php
伊玛目的门徒1 小时前
试用leetcode之典中典 二数之和问题
java·算法·leetcode
懒鸟一枚4 小时前
深入理解 Linux 内存、Swap 交换分区与分页机制的关系
java·linux·数据库
我命由我123456 小时前
执行 Gradle 指令报错,无法将“grep”项识别为 cmdlet、函数、脚本文件或可运行程序的名称
android·java·java-ee·android studio·android jetpack·android-studio·android runtime
考虑考虑6 小时前
Sentinel安装
java·后端·微服务
凤凰院凶涛QAQ7 小时前
《Java版数据结构 & 集合类剖析》栈与队列:“push/pop 是栈的灵魂,offer/poll 是队列的骨架——四组 API,两种人生”
java·开发语言·数据结构
掘金_答案8 小时前
上线那天,一个 ConcurrentHashMap 差点送走我的 AI 客服——3 天排查 JVM 血泪史
java·后端·架构
猿与禅9 小时前
CosId 分布式 ID 生成器完全教程:从架构原理到生产落地
java·shardingsphere·雪花算法·分布式id·高性能·cosid·号段模式
MindUp9 小时前
企业网盘权限模型解析:多层级访问控制与审计能力选型指南
java·linux·运维
NG4779 小时前
【软件设计与体系结构】-策略设计模式
java·设计模式·软件工程