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自动生成注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

在MyBatis的XML映射文件中＜trim＞元素所有场景下的完整使用示例代码
在MyBatis的XML映射文件中,<trim>元素用于动态添加SQL语句的一部分,处理前缀、后缀及多余的逗号或连接符,示例展示了如何在UPDATE、SELECT、INSERT和SQL片段中使用<trim>元素,以实现动态的SQL构建,感兴趣的朋友一起看看吧
2025-01-01
Java字符串String相关类常用方法详解
这篇文章主要介绍了Java中的字符串数据类型,包括字符串的创建、拼接、比较和常用方法,还介绍了StringBuilder和StringJoiner类的定义和使用,以及它们在内存中的管理方式,需要的朋友可以参考下
2025-02-02
如何实现Java中一个简单的LinkedList
LinkedList与ArrayList都是List接口的具体实现类。下面将介绍如何实现一个简单的LinkedList，具有很好的参考价值，下面跟着小编一起来看下吧
2017-02-02
SpringBoot整合Shiro框架,实现用户权限管理
Apache Shiro是一个强大且易用的Java安全框架,执行身份验证、授权、密码和会话管理。作为一款安全框架Shiro的设计相当巧妙。Shiro的应用不依赖任何容器，它不仅可以在JavaEE下使用，还可以应用在JavaSE环境中。
2021-06-06
Springboot使用token防止重复提交表单问题
文章主要描述了一个关于用户登录测试的过程,涉及到了DuplicateSubmitToken、DuplicateSubmitExceptionTextConstants和DuplicateSubmitAspect等术语,这些可能是在测试过程中用于防止重复提交的功能或注解
2026-05-05
Java字符串正则表达式详解
这篇文章主要介绍了java使用正则表达式查找包含的字符串功能,结合具体实例形式分析了java针对字符串匹配查找的相关实现技巧,需要的朋友可以参考下
2021-09-09
SpringBoot2.3定制错误页面的方法示例
这篇文章主要介绍了SpringBoot2.3定制错误页面的方法示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
如何通过Maven仓库安装Spire系列的Java产品
这篇文章主要介绍了如何通过Maven仓库安装Spire系列的Java产品,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-07-07
基于Java实现本地APK文件搜索与HTTP下载服务
在移动应用开发和测试过程中,经常需要从本地服务器获取最新的 APK 安装包,本文将详细介绍如何使用 Java 构建一个能够搜索本地最新 APK 文件并通过 HTTP 请求提供下载服务的应用
2025-07-07
spring boot启动后直接关闭了的问题解决
本文主要介绍了spring boot启动后直接关闭了的问题解决,SpringBoot项目启动后自动关闭的原因是未引入web依赖,导致以普通Java项目运行,下面就来介绍一下解决方法,感兴趣的可以了解一下
2025-02-02