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
相关推荐
hero_heart20 分钟前
vscode中c_cpp_properities.cpp文件生成和作用
ide·vscode·编辑器
缘来是庄25 分钟前
设计模式之访问者模式
java·设计模式·访问者模式
Bug退退退1231 小时前
RabbitMQ 高级特性之死信队列
java·分布式·spring·rabbitmq
梵高的代码色盘1 小时前
后端树形结构
java
代码的奴隶(艾伦·耶格尔)1 小时前
后端快捷代码
java·开发语言
虾条_花吹雪1 小时前
Chat Model API
java
双力臂4042 小时前
MyBatis动态SQL进阶:复杂查询与性能优化实战
java·sql·性能优化·mybatis
六毛的毛2 小时前
Springboot开发常见注解一览
java·spring boot·后端
程序漫游人2 小时前
centos8.5安装jdk21详细安装教程
java·linux
超级码.里奥.农3 小时前
零基础 “入坑” Java--- 七、数组(二)
java·开发语言