IDEA自动生成注释模板的配置教程

更新时间：2025年04月18日 10:38:40 作者：代码怪兽大作战

本文介绍了如何在IntelliJIDEA中配置类和方法的注释模板,包括自动生成项目名称、包名、日期和时间等内容,以及如何定制参数和返回值的注释格式,需要的朋友可以参考下

项目场景

IDEA自动生成注释模板配置方法（包括类模板和方法模板）

配置方法

类注释模板

根据图片的步骤，进入设置类注释模板处进行修改填入相应内容。
File ——> Settings ——> Editor ——> File and Code Templates ——>File Header

定义类开头的注释

/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: xxxx
*@CreateTime: ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

在这个模板中，我们使用了
$ {PROJECT_NAME}、$ {PACKAGE_NAME}、$ {YEAR}、$ {MONTH}、$ {DAY}、$ {HOUR} 和
$ {MINUTE} 内置的模板变量来自动生成当前项目名称、包名以及当前日期和时间。您可以在模板中编辑其他信息，如作者名、描述等。

步骤

在这里插入图片描述

类注释效果

在这里插入图片描述

方法注释模板

根据图片的步骤，进入设置类注释模板处进行修改填入相应内容。
File ——> Settings ——> Editor ——> Live Templates

定义方法开头的注释

方法注释模板

**
* @description: TODO $description$
* @author: LLong
* @date: $date$ $time$
$param$
* @return: $return$
**/

注意：修改Edit Varuavkes中需要定义的参数以及生成方式（如：Expand with 为 enter）

date 参数

date("yyyy/MM/dd")

time 参数

time("HH:mm:ss")

param 参数

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) ? '\\n' : '')}; return result", methodParameters())

return 参数

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

步骤

在这里插入图片描述

方法注释效果

在这里插入图片描述

到此这篇关于IDEA自动生成注释模板的配置教程的文章就介绍到这了,更多相关IDEA自动生成注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

spring中@ComponentScan自动扫描并指定扫描规则
本文主要介绍了spring中@ComponentScan自动扫描并指定扫描规则，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-04-04
Java NIO下ByteBuffer的常用方法学习
这篇文章主要带大家来初步学习一下NIO 中的 ByteBuffer的应用与常用方法，文中的示例代码讲解详细，对我们深入学习Java有一定的帮助，感兴趣的可以了解一下
2023-05-05
解决springboot报错Could not resolve placeholder‘x
这篇文章主要介绍了解决springboot报错:Could not resolve placeholder ‘xxx‘ in value “${XXXX}问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-11-11
Kotlin中使用Java数据类时引发的Bug解决方式
这篇文章主要介绍了Kotlin中使用Java数据类时引发的一个Bug,本文给大家分享问题解决方式，感兴趣的朋友跟随小编一起看看吧
2023-09-09
SpringBoot实现海量数据高效实时搜索功能
我们都知道随着业务系统的发展和使用,数据库存储的业务数据量会越来越大,逐渐成为了业务系统的瓶颈,本文给大家介绍了Spring Boot业务系统如何实现海量数据高效实时搜索,文中有详细的代码示例,需要的朋友可以参考下
2023-10-10
Java中List for循环的6种写法总结(推荐)
下面小编就为大家带来一篇Java中List for循环的6种写法总结(推荐)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-06-06
Java ThreadPool的使用解析
这篇文章主要介绍了Java ThreadPool的使用解析，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
2020-10-10
基于FeignClient调用超时的处理方案
这篇文章主要介绍了基于FeignClient调用超时的处理方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
Spring基于注解管理bean实现方式讲解
很多时候我们需要根据不同的条件在容器中加载不同的Bean，或者根据不同的条件来选择是否在容器中加载某个Bean，这就是Bean的加载控制，一般我们可以通过编程式或注解式两种不同的方式来完成Bean的管理
2023-01-01
Java 手动解析不带引号的JSON字符串的操作
这篇文章主要介绍了Java 手动解析不带引号的JSON字符串的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-10-10