VSCode 定义Java类注释

在使用 VSCode 开发 Java 时，输入 /** 生成的类注释如下：

/**
 * 
 */

这样的注释一片空白，无法标注类的作者、创建时间等信息。

可以通过如下设置实现更贴合 Java 类的注释：

1. 进入 Java 配置

   

   输入 settings.json

   

​ 选择 Preferences:Open User Settings(JSON)

2. 添加 Java 配置

   在打开的 settings.json 中添加如下代码：

   "java.templates.typeComment": [
       "/**",
       " * ",
       " * @author 作者名",
       " */"
   ]
   

这样就自定义了 Java 的类注释了，此时再输入 /** 生成的类注释如下：

/**
 * 
 *
 * @author 作者名
 */

还可以使用一些变量来生成更丰富的注释：

• ${file_name}：当前文件名称
• ${package_name}：包名
• ${type_name}：类名
• ${user}：系统登录用户名
• ${date}：系统日期
• ${time}：系统时间
• ${year}：当前年份
• ${month}：当前月份
• ${shortmonth}：当前月份短
• ${day}：日期
• ${hour}：小时
• ${minute}：分钟

环境：

• VS Code 1.93.1