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

相关推荐
零千叶12 小时前
【面试】AI大模型应用原理面试题
java·设计模式·面试
坐吃山猪17 小时前
SpringBoot01-配置文件
java·开发语言
我叫汪枫17 小时前
《Java餐厅的待客之道:BIO, NIO, AIO三种服务模式的进化》
java·开发语言·nio
yaoxtao17 小时前
java.nio.file.InvalidPathException异常
java·linux·ubuntu
Swift社区19 小时前
从 JDK 1.8 切换到 JDK 21 时遇到 NoProviderFoundException 该如何解决?
java·开发语言
DKPT20 小时前
JVM中如何调优新生代和老生代?
java·jvm·笔记·学习·spring
phltxy20 小时前
JVM——Java虚拟机学习
java·jvm·学习
seabirdssss21 小时前
使用Spring Boot DevTools快速重启功能
java·spring boot·后端
喂完待续21 小时前
【序列晋升】29 Spring Cloud Task 微服务架构下的轻量级任务调度框架
java·spring·spring cloud·云原生·架构·big data·序列晋升