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
相关推荐
小满、36 分钟前
Java 值传递
java·java 值传递
IT枫斗者枫哥38 分钟前
Java 异步导出只测最终行数,为什么下载时仍会少一行?
java·后端
张紫娃1 小时前
idea 如何看一个类的 .class 文件
java·ide·intellij-idea
南宫鑫1 小时前
Java底层实现
java
AI人工智能+电脑小能手1 小时前
IP地址合法性校验,这个Java工具类4个方法纯字符不查DNS
java·网络工具·ip校验·ipv6归一·字符校验
斯维赤1 小时前
SpringBoot接口调不通排查终极方案
java·后端·spring
山楂树の1 小时前
Java BigDecimal笔记
java·开发语言
旋风菠萝2 小时前
HashMap和CurrentHashMap的key可以为空吗
java·数据库·redis
开开心心就好3 小时前
PDF水印怎么去掉?勾选对象再点匹配
java·前端·mysql·支持向量机·pdf·音视频·模拟退火算法
Flynn Liang3 小时前
Java 虚拟线程别乱用:I/O 密集型服务的线程模型与并发度计算
java·spring boot·性能优化·高并发·线程池·虚拟线程