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
相关推荐
YuTaoShao1 小时前
【LeetCode 热题 100】56. 合并区间——排序+遍历
java·算法·leetcode·职场和发展
程序员张31 小时前
SpringBoot计时一次请求耗时
java·spring boot·后端
llwszx4 小时前
深入理解Java锁原理(一):偏向锁的设计原理与性能优化
java·spring··偏向锁
云泽野5 小时前
【Java|集合类】list遍历的6种方式
java·python·list
二进制person5 小时前
Java SE--方法的使用
java·开发语言·算法
小阳拱白菜6 小时前
java异常学习
java
lyj1689977 小时前
vue-i18n+vscode+vue 多语言使用
前端·vue.js·vscode
FrankYoou7 小时前
Jenkins 与 GitLab CI/CD 的核心对比
java·docker
麦兜*8 小时前
Spring Boot启动优化7板斧(延迟初始化、组件扫描精准打击、JVM参数调优):砍掉70%启动时间的魔鬼实践
java·jvm·spring boot·后端·spring·spring cloud·系统架构
KK溜了溜了8 小时前
JAVA-springboot 整合Redis
java·spring boot·redis