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
相关推荐
hbwhmama6 分钟前
ubuntu24.04安装IDEA2025.1.2搭建java开发环境
java·开发语言
hbh112233abc23 分钟前
VSCode中PHP使用Xdebug
ide·vscode·php
真夜33 分钟前
个人spring-boot问题记录
java·后端
程序员小奕35 分钟前
springboot 百货中心供应链管理系统小程序
java·spring boot·后端
刘白Live44 分钟前
【Java】为什么有时候执行countDownLatch+线程池查询列表会丢失数据?
java·后端
剑海风云1 小时前
适应性Java用于现代 API:REST、GraphQL 和事件驱动
java·api·restful·graphql·事件驱动
会飞的架狗师1 小时前
【面试题】如何保证MQ的消息不丢失、不重复
java·面试·kafka·java-rocketmq
蔡蓝1 小时前
设计模式-备忘录模式
java·设计模式·备忘录模式
迢迢星万里灬2 小时前
Java求职者面试指南:Spring、Spring Boot、Spring MVC与MyBatis技术解析
java·spring boot·spring·mybatis·spring mvc·面试指南
只有干货2 小时前
java若依 excel 导出高度自适应
java·excel