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
相关推荐
妙极矣6 分钟前
JAVAEE初阶01
java·学习·java-ee
碎叶城李白20 分钟前
NIO简单群聊
java·nio
xxjiaz40 分钟前
水果成篮--LeetCode
java·算法·leetcode·职场和发展
CodeFox1 小时前
动态线程池 v1.2.1 版本发布,告警规则重构,bytebuddy 替换 cglib,新增 jmh 基准测试等!
java·后端
ℳ₯㎕ddzོꦿ࿐1 小时前
Java集成Zxing和OpenCV实现二维码生成与识别工具类
java·opencv
雪落山庄1 小时前
LeetCode100题
java·开发语言·数据结构
码熔burning2 小时前
【MQ篇】RabbitMQ之发布订阅模式!
java·分布式·rabbitmq·mq
XiaoLeisj2 小时前
【设计模式】深入解析代理模式(委托模式):代理模式思想、静态模式和动态模式定义与区别、静态代理模式代码实现
java·spring boot·后端·spring·设计模式·代理模式·委托模式
李少兄2 小时前
解决Spring Boot版本冲突导致的`NoSuchFieldError`
java·spring boot·后端
pwzs2 小时前
常见的 Spring Boot 注解汇总
java·spring boot·后端·spring