VSCode 定义Java类注释

在使用 VSCode 开发 Java 时,输入 /** 生成的类注释如下:

java 复制代码
/**
 * 
 */

这样的注释一片空白,无法标注类的作者、创建时间等信息。

可以通过如下设置实现更贴合 Java 类的注释:

  1. 进入 Java 配置

    输入 settings.json

​ 选择 Preferences:Open User Settings(JSON)

  1. 添加 Java 配置

    在打开的 settings.json 中添加如下代码:

    json 复制代码
    "java.templates.typeComment": [
        "/**",
        " * ",
        " * @author 作者名",
        " */"
    ]

这样就自定义了 Java 的类注释了,此时再输入 /** 生成的类注释如下:

json 复制代码
/**
 * 
 *
 * @author 作者名
 */

还可以使用一些变量来生成更丰富的注释:

  • ${file_name}:当前文件名称
  • ${package_name}:包名
  • ${type_name}:类名
  • ${user}:系统登录用户名
  • ${date}:系统日期
  • ${time}:系统时间
  • ${year}:当前年份
  • ${month}:当前月份
  • ${shortmonth}:当前月份短
  • ${day}:日期
  • ${hour}:小时
  • ${minute}:分钟

环境:

  • VS Code 1.93.1
相关推荐
jianqiang.xue10 分钟前
把Agent塞进MCU:工具次数和上下文长度怎么卡
java·前端·网络·单片机·esp32·ai编程
ikgy1 小时前
JAVA EE:4.多线程核心组件实战
java·java-ee
杨凯凡1 小时前
IT日报|2026-11-19:Oracle Java 紧急补丁、Optimizely 供应链攻击、GitHub 安全评估升级
java·oracle·github
JasonChen@6662 小时前
2.Tomcat 安装部署与一键自动化脚本实战
java·tomcat
SimonKing3 小时前
零 OCR 依赖!Firecrawl 这个 Rust 库把 Word / PPT / Excel 全变成 Markdown
java·后端·程序员
Rain的Java大神之路3 小时前
别被 ChatGPT 的打字机效果骗了:一字一字蹦,才是 LLM 自回归的命门(附大厂 Java 流式落地)
java·后端·面试
渣渣盟3 小时前
狂命爆肝99天,共52K字的JAVA学习笔记奉上,JAVA从入门到精通一文搞定,一文在手JAVA无忧
java·笔记·学习
星落梦生4 小时前
Maven高级(9)
java·maven
兴趣互联15 小时前
jeecgboot nacos2.3.2 使用pgsql
java
hudd66815 小时前
JavaEE 初阶 - 文件操作和IO
java·开发语言·java-ee