IDEA中如何配置Java类注释(Java类注释信息配置,如作者、备注、时间等)

🤟致敬读者

  • 🟩感谢阅读🟦笑口常开🟪生日快乐⬛早点睡觉

📘博主相关


文章目录

  • IDEA中如何配置Java类注释
    • [1. 背景](#1. 背景)
    • [2. 配置入口](#2. 配置入口)
      • [2.1 进入设置界面](#2.1 进入设置界面)
      • [2.2 进入文件头配置界面](#2.2 进入文件头配置界面)
    • [3. 查看效果](#3. 查看效果)
    • [4. 黄色虚线剔除](#4. 黄色虚线剔除)

📃文章前言

  • 🔷文章均为学习工作中整理的笔记。
  • 🔶如有错误请指正,共同学习进步。



IDEA中如何配置Java类注释

1. 背景

在 IntelliJ IDEA 中创建新类文件时,默认情况下不会包含任何额外信息。

若希望在生成的类文件中自动添加注释信息(如下所示),可以通过以下方式实现:

2. 配置入口

2.1 进入设置界面

IDEA左上角File-->Settings...进入设置界面

或快捷键ctrl+alt+s进入设置界面

2.2 进入文件头配置界面

搜索框搜索file tem

或者Editor--->File and Code Templates

选择Includes--->File Header

然后将以下内容复制粘贴到文本区域中(内容可自行修改)

text 复制代码
/**
 * @Description: 
 * @JDK_Version: 25
 * @Author: 岫珩
 * @Date: ${DATE} ${DAY_NAME_FULL} ${TIME}
 */

然后勾选Enable Live Templates选项来开启头部注释模板,然后Apply-->OK

3. 查看效果

新建类文件,查看默认生成的头部注释

4. 黄色虚线剔除

可以看到注释的部分内容都是黄色虚线,因为这几个字段都带@符号,所以是不规范的

如何消除黄色虚线,可以鼠标悬浮在虚线上,出现弹窗

选择Add @Ddescription: to custom tags,或直接使用快捷键Alt+Shift+Enter

同样方式将所有黄色虚线内容作为自定义标签处理即可消除

消除后的效果如下

以上就是头部注释配置的所有内容,感谢阅读。



📜文末寄语

  • 🟠关注我,解锁更多优质内容
  • 🟡技术前沿 | 实战干货 | 疑难解答,持续更新中
  • 🟢加入《全栈知识库》,与各领域开发者共创技术盛宴
  • 🔵进入《专属社群》,技术路上结伴同行,共同成长
  • 🟣点击下方名片,获取更多精彩内容👇

相关推荐
2601_9621066410 小时前
【Java Set综合实战】商品管理系统 + 图书收藏系统|Product、Book自定义类全套代码
java
RuoyiOffice10 小时前
SpringBoot+Vue3 凭证生命周期设计:审核、过账、冲销与反过账怎样保持账目一致
java·spring boot·事务·springboot3·财务系统·会计凭证·ruoyi office
2601_9621066411 小时前
HashMap入门|工号-姓名键值存储、两种遍历方式、根据key/value查
java
杨凯凡11 小时前
Spring Framework 7 API 版本管理实战:请求头路由、兼容迁移与废弃策略
java·rest api·springframework·spring boot 4·api版本管理
T_Wizard12 小时前
同一个问题写了 4 遍:官方 SDK / HTTP / Spring AI / LangChain4j,到底该选哪个
java·ai编程
hai_android12 小时前
AudioTrack 深度解析:从原理到实战
android·java·kotlin
斯维赤12 小时前
限流、熔断、降级,你真的分得清吗?
java·后端·架构
aiks_yuan15 小时前
Java CPU 100% 怎么排查:JDK 11 起 jstack 自带线程 CPU 时间,不用再 top -H 换算十六进制(JDK 8、11、17 实测)
java
Flynn Liang16 小时前
AiServices 源码级拆解:一个接口如何变成 RAG Agent
java·langchain·源码分析·rag·langchain4j·aiservices
Flynn Liang16 小时前
LangChain4j 1.23 架构全景:Java 大模型应用的 6 层抽象
java·langchain·大模型·rag·ai agent·langchain4j