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
相关推荐
_hermit:2 分钟前
【从零开始java学习|小结】记录学习和编程中的问题
java·学习
小柯J桑_3 分钟前
C++之特殊类设计
java·开发语言·c++
菜鸟plus+7 分钟前
Java NIO
java·nio
君不见,青丝成雪7 分钟前
Java中IntStream的详细用法及典型案例
java
QiZhang | UESTC8 分钟前
JAVA算法练习题day11
java·开发语言·python·算法·hot100
FenceRain8 分钟前
spring boot 拦截器增加语言信息
java·spring boot·后端
星月前端9 分钟前
idea没法识别springboot项目的一个原因解决及办法
java·spring boot·intellij-idea
爱笑的源码基地9 分钟前
智慧城管源码,java版城管综合执法监督系统微服务源码
java·源码·软件开发·智慧城管·城管执法系统·数字城管·城管综合管理系统
bigdata-rookie10 分钟前
Java 反射
java·开发语言
烽学长11 分钟前
(附源码)基于Spring Boot社区“邻里帮”平台的设计与实现
java