函数注释如图所示
在这里插入图片描述

一、安装插件KoroFileHeader(函数标准注释)

在插件市场搜索KoroFileHeader,并安装,如下:
在这里插入图片描述

二、设置函数注释标准

选择顶部文件,找到首选项,选择设置,然后输入“fileheader”

在这里插入图片描述

  • 文件头部注释:Fileheader:custom Made
  • 函数注释:Fileheader:cursor Mode

在setting.json"中编辑,输入以下设置后保存,然后重启vscode更新设置:

  // 快速添加文件头部注释和函数注释
  "fileheader.configObj": {
    "createFileTime": true, //设置为true则为文件新建时候作为date,否则注释生成时间为date
    "autoAdd": false, //自动生成注释
    "annotationStr": {
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": true //设置自定义注释可用
    },
  },
  "fileheader.cursorMode": {
    "description": "",
    "autoAdd": false, //自动生成注释
    // "Author": "Wiwen",
    "Date": "Do not edit",
    "param ": "",
  },
  "fileheader.customMade": {
    "Description": "", //文件内容描述
    "Date": "Do not edit", //时间
    "LastEditTime": "Do not edit",
    "LastEditors": "",
    "Reference": ""
  },

  
AI写代码 javascript
运行
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25

三、快捷键使用

文件头部注释
快捷键:crtl+alt+i(window),ctrl+cmd+t (mac)

函数注释
快捷键:ctrl+alt+t (window), ctrl+alt+t(mac)

四、快捷键失效问题解决

快捷键失效原因是因为被占用

文件→首选项→键盘快捷方式
输入cursorTip代表函数头部注释,fileheader代表文件头注释。
在这里插入图片描述
改成需要的快捷键即可

            </div>
Logo

腾讯云面向开发者汇聚海量精品云计算使用和开发经验,营造开放的云计算技术生态圈。

更多推荐