IDEA中如何自定义注释模板

简介: IDEA中如何自定义注释模板

背景

在我们日常开发中,都会存在很多加入注释的地方,比如类、再比如方法,甚至参数名,返回结果。

但是这个时候呢,我们就可以使用IDEA中的自定义注释模板来初始化注释了。

就比如:

  /**  
    * @description: TODO
    * @author ${USER}
    * @date ${DATE}${TIME}
    */

这样的注释模板既可以适用于修饰类,也可以用来修饰方法。

下面就来看一下如何设置吧。

知识点

首先我们来打开File————>Setting--->Editor--->Filr and Code Templates--->Includes--->File Header。

还是来一张图更方便看,上图!

image.png在这里其实有着很多文件的类型,如HTML、Class、interface、css等等,每个类型都有自己的模板。

这里如果没有太理解的话,也可以这么理解,当我们创建一个文件时,通常会初始化出一些信息来,比如创建类时,会自动生成pulic class 类名{},当然了还有包名之类的。

今天我们来说一下Class中的模板定义。

在Class类型中,就可以指定我们文中一开始的注释了。

image.png如上图,再解释一下这几个注解参数的含义吧。

@description: 方法描述信息
@author 创建者,
${user}是当前计算机的用户名
@date 时间点
${DATE}:日期,如2021-09-09
${TIME}:时间,如12:00:01

每天记录一下自己上班需要百度的问题,永远相信美好的事情即将发生。

目录
打赏
0
0
0
0
2
分享
相关文章
IDEA + 通义灵码AI程序员:快速构建DDD后端工程模板
本文介绍如何使用 IntelliJ IDEA 和阿里云的通义灵码 AI 程序员,快速搭建基于 DDD 领域驱动设计的后端工程模板。通过安装和配置 IDEA、JDK、Maven 及通义灵码插件,用户可以借助 AI 自动生成项目结构和代码。然而,测试发现 AI 生成的代码存在依赖问题,需手动修正才能成功运行。最终,项目包括 Spring Boot、Maven 和 Deepseek API 集成,可调用大模型进行预测。尽管 AI 工具提高了开发效率,但目前仍需人工干预确保项目顺利运行。
41 2
 IDEA + 通义灵码AI程序员:快速构建DDD后端工程模板
|
7天前
|
Idea自动生成注释
Idea自动生成注释
23 6
Idea自动生成注释
IDEA + 通义灵码 AI 程序员:快速构建 DDD 后端工程模板
本文介绍了如何利用 IntelliJ IDEA 编辑器和阿里云的通义灵码 AI 程序员,快速搭建一个基于 DDD 领域驱动架构的后端工程模板。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
58 6
|
4月前
|
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
150 2
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
88 2
|
4月前
|
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
340 0
如何在IDEA中自定义模板、快速生成完整的代码?
这篇文章介绍了如何在IntelliJ IDEA中使用easycode插件自定义代码生成模板,以快速生成Spring Boot、MyBatis等项目中常见的Controller、Service、Dao、Mapper等组件的代码。
如何在IDEA中自定义模板、快速生成完整的代码?
IDEA 行注释设置,使其不从顶格开始,让其处于代码前开始
这篇文章提供了IntelliJ IDEA中如何设置行注释不从顶格开始,而是紧接在代码前面的方法,通过访问Settings中的Code Style选项进行调整,以改善代码注释的视觉效果。

热门文章

最新文章