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

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

目录
相关文章
|
22天前
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
29 6
|
21天前
|
Java
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
|
1月前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
28 2
|
1月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
|
3月前
|
Java 数据库连接 Spring
如何在IDEA中自定义模板、快速生成完整的代码?
这篇文章介绍了如何在IntelliJ IDEA中使用easycode插件自定义代码生成模板,以快速生成Spring Boot、MyBatis等项目中常见的Controller、Service、Dao、Mapper等组件的代码。
如何在IDEA中自定义模板、快速生成完整的代码?
|
3月前
|
XML 数据格式
IDEA 行注释设置,使其不从顶格开始,让其处于代码前开始
这篇文章提供了IntelliJ IDEA中如何设置行注释不从顶格开始,而是紧接在代码前面的方法,通过访问Settings中的Code Style选项进行调整,以改善代码注释的视觉效果。
|
3月前
|
Java
Java系列之 IDEA 为类 和 方法设置注解模板
这篇文章介绍了如何在IntelliJ IDEA中为类和方法设置注解模板,包括类模板的创建和应用,以及两种不同的方法注解模板的创建过程和实际效果展示,旨在提高代码的可读性和维护性。
IDEA如何设置取消 请不要使用行尾注释 提示
文章介绍了如何在 IntelliJ IDEA 中设置以取消行尾注释的提示。这个问题通常由使用阿里规范插件导致,插件会在不满足规范时在代码中显示黄色波浪线提示。为了改善代码编辑体验,文章提供了详细的步骤说明,指导用户通过进入 "File" -> "Settings" -> "Editor" -> "Inspections" 来取消特定检查项,从而消除这些提示。修改设置后,代码界面将不再显示黄色波浪线,看起来更加清爽。
IDEA如何设置取消 请不要使用行尾注释 提示
|
4月前
|
SQL Java 数据库连接
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
89 3
|
3月前
IDEA——代码文件如何插入作者注释
IDEA——代码文件如何插入作者注释
43 0