安装

  • 安装完vscode 安装插件 koroFileHeader
  • 选择 文件—-首选项 —— 设置 用户设置打开 settings.json 添加或者覆盖一下代码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
"fileheader.cursorMode": {
},
"fileheader.customMade": {
  "Author": "hyman", // 
  "Date": "", // 文件创建时间
  "LastEditors": "hyman", // 文件最后编辑者
  "LastEditTime": "", // 文件最后编辑时间
  "Description":"请填写简介",
},

"fileheader.configObj": {
  "CheckFileChange": true, // 默认关闭
  "wideSame": false, // 设置为true开启
  "wideNum": 13, // 字段长度 默认为13
  "createHeader": true // 创建文件自动添加注释
},
  • 重新启动vscode 完成。

测试

  • 文件头部注释：

在当前编辑文件中使用快捷键:window：ctrl+alt+i/mac：ctrl+cmd+i,即可生成文件头部注释。
可以自动创建创建时间更新和最后修改时间

  • 函数注释：

将光标放在函数行或者将光标放在函数上方的空白行
使用快捷键window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函数注释。
事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。

效果如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
头部注释
<!--
 * @Author: hyman
 * @Date: 2021-02-01 19:43:39
 * @LastEditors: hyman
 * @LastEditTime: 2021-02-01 19:59:57
 * @Description: 请填写简介
-->

函数注释
  /**
   * @description: 
   * @param {*} appId
   * @param {*} bucket
   * @param {*} region
   * @param {*} folder
   * @param {*} authUrl
   * @return {*}
   */

__END__

Live For Code
文章作者：Live For Code
文章出处：vscode 自动注释插件推荐
作者签名：简单地活着, 肆意又精彩.
关于主题：Hexo - Live For Code
版权声明：文章除特别声明外，均采用 BY-NC-SA 许可协议，转载请注明出处