vscode 插件-自动生成注释

这是我参与8月更文挑战的第13天，活动详情查看：8月更文挑战

前言

安利一个vscode插件，
用于生成文件头部注释和函数注释的插件 效果如下

安装

• 安装完vscode 安装插件 koroFileHeader

• 选择 文件—-首选项 —— 设置 或者

用户设置打开 settings.json 添加或者覆盖以下代码

  "fileheader.cursorMode": {
  },
  "fileheader.customMade": {
    "Author": "hyman", // 改成你的名字
    "Date": "", // 文件创建时间
    "LastEditors": "hyman", // 文件最后编辑者
    "LastEditTime": "", // 文件最后编辑时间
    "Description":"请填写简介",
  },
  
  "fileheader.configObj": {
    "CheckFileChange": true, // 默认关闭
    "wideSame": false, // 设置为true开启
    "wideNum": 13, // 字段长度 默认为13
    "createHeader": true // 创建文件自动添加注释
  },
复制代码

• 上面配置中的Author 记住改成你自己的名字
• 重新启动vscode 完成。

测试

1. 文件头部添加注释:

   • 在文件开头添加注释，记录文件信息/文件的传参/出参等
   • 支持用户高度自定义注释选项, 适配各种需求和注释。
   • 保存文件的时候，自动更新最后的编辑时间和编辑人
   • 快捷键：window：ctrl+alt+i,mac：ctrl+cmd+i, linux: ctrl+meta+i

2. 在光标处添加函数注释:

   • 在光标处自动生成一个注释模板, 自动解析函数参数，生成函数参数注释。
   • 支持用户高度自定义注释选项
   • 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t,linux: ctrl+meta+t
   • 快捷键不可用很可能是被占用了,参考这里

3. 支持一键添加佛祖保佑永无BUG、神兽护体等注释图案 （实测，没有用，还是会有bug 哈哈）

效果如下

头部注释
<!--
 * @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 {*}
   */
复制代码