idea自动生成注释

idea 自动生成注释

1 创建类时,自动生成注释

模板代码如下

复制代码
/**
* @program: ${PROJECT_NAME}   
*
* @description: ${description}   
*
* @author: yun
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}     
**/

2 在方法上使用快捷键生成注释

先新建一个template group,我命名为mygroup,再在group新建live template

实现参数类似eclipse的效果,多个参数自动换行

复制代码
     /**
     * @Description: TODO 描述方法主要功能
     *
     * @Param: pageNo
     * @Param: pageSize
     * @Param: filterTimestamp
     * @Return: java.util.List
     * @Author: yun
     * @Date: 2025/2/17 18:13
     */
    List listV2(Integer pageNo, Long filterTimestamp);

template text模板如下

复制代码
 *
 * @Description: TODO 描述方法主要功能
 * $param$
 * @Return: $return$
 * @Author: yun
 * @Date: $date$ $time$
 */

注意这里需要左缩减一个空格

选择模板应用到java代码

edit variables进行模板参数编辑

如果param参数使用默认的methodParameters()来获取方法参数值,其注释参数是在一行展示的,如下图。这里我们希望像MyEclipse中一样,一行一个参数的样式,可以通过脚本来实现。将以下脚本复制进Expression,可以得到文章开头效果图的样式

复制代码
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

3 效果

使用默认的拓展快捷键tab, /** + tab进行自动显示方法注释

如果

4 导入导出配置

5 参考链接

IDEA中设置注释模板_idea配置注释模板-CSDN博客

相关推荐
武子康37 分钟前
Java-136 深入浅出 MySQL Spring Boot @Transactional 使用指南:事务传播、隔离级别与异常回滚策略
java·数据库·spring boot·mysql·性能优化·系统架构·事务
微笑尅乐7 小时前
力扣350.两个数组的交集II
java·算法·leetcode·动态规划
rzjslSe7 小时前
【JavaGuide学习笔记】理解并发(Concurrency)与并行(Parallelism)的区别
java·笔记·学习
青柠编程8 小时前
基于Spring Boot的竞赛管理系统架构设计
java·spring boot·后端
꒰ঌ 安卓开发໒꒱8 小时前
Java面试-并发面试(二)
java·开发语言·面试
Mr.Aholic8 小时前
Java系列知识之 ~ Spring 与 Spring Boot 常用注解对比说明
java·spring boot·spring
月夕·花晨9 小时前
Gateway-断言
java·开发语言·分布式·spring cloud·微服务·nacos·sentinel
西贝爱学习9 小时前
【JDK 11 安装包免费下载 免登录Oracle 】jdk11与jdk8有什么区别?
java·开发语言
宠友信息9 小时前
类似小红书垂直社区APP小程序源码
java·开发语言·微信小程序·小程序·uni-app·开源·web app
yujkss10 小时前
23种设计模式之【享元模式】-核心原理与 Java实践
java·设计模式·享元模式