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
相关推荐
wei844067872几秒前
本地项目第一次推送到gitee上的完整命令
java·android studio
星球奋斗者3 分钟前
计算机方向如何才能更好的找到工作?(成长心得)
java·后端·考研·软件工程·改行学it
Jabes.yang3 分钟前
互联网大厂Java面试:缓存技术与监控运维的深度探讨
java·面试指南·缓存技术·监控运维
海梨花10 分钟前
【八股笔记】SSM
java·开发语言·笔记·后端·面试·框架
珹洺21 分钟前
Java-Spring入门指南(二十五)Android 的历史,认识移动应用和Android 基础知识
android·java·spring
只想码代码24 分钟前
什么是程序计数器?
java·jvm
JAVA学习通27 分钟前
OJ竞赛平台----C端题目列表
java·开发语言·jvm·vue.js·elasticsearch
得物技术1 小时前
从 JSON 字符串到 Java 对象:Fastjson 1.2.83 全程解析|得物技术
java·后端·json
JAVA学习通1 小时前
基本功 | 一文讲清多线程和多线程同步
java·开发语言·多线程
啦啦9117141 小时前
如何理解Java中的并发?
java·开发语言