两步轻松搞定,VSCode中为代码快捷设置文件头部注释与函数注释

959 阅读2分钟

两步轻松搞定,VSCode中为代码快捷设置文件头部注释与函数注释

积跬步,至千里。

项目开发过程中,为其中的一些文件或方法函数添加一些辅助性的注释是常有的事,方便自己以后阅读,也方便他人。

本文主要介绍使用VSCode工具开发项目时,使用插件为项目快捷添加自定义的文件头部注释函数注释

一、首先安装快捷注释插件 — koroFileHeader

  • 在vscode中插件市场处通过搜索koroFileHeader,来定位并安装插件,如下图:

image.png

二、给插件配置快捷的内容

  • 在vscode的设置中搜索filehead,来定位插件的配置json文件,如下图:

image.png

image.png

  • 选择三个设置的任意一个,这里选择第一个,点击在setting.json中编辑,进入配置文件
  • 直接在配置文件的开头配置中添加文件注释配置函数配置,其中的配置内容根据自己意愿进行编辑,如下图:

image.png 附配置代码,如下:

// 文件头部
    "fileheader.customMade": {
        "Descripttion": "niu的代码",
        "version": "1.0.0",
        "Author": "niu",
        "Date": "Do not edit",
        "LastEditors": "niu",
        "LastEditTime": "Do not Edit"
    },
    // 函数注释
    "fileheader.cursorMode": {
        "name": "",
        "msg": "",
        "param": "",
        "return": ""
    },
  • 最后,就可以在js文件中使用快捷键生成自己的文件注释与函数注释啦。(ctrl+win+t:函数注释;ctrl+win+i:文件头部注释)

image.png

  • 注意:若快捷键无效,可继续阅读下面部分,自行配置(这里也可以配置自己个性化的快捷键)

快捷键无效的解决

  • 在vscode的设置中找到键盘快捷方式,如下图:

image.png

  • 检索filehead,就可以找到快捷生成文件头部注释的快捷键,如下图: image.png
  • 检索cursortip,就可以找到快捷生成函数注释的快捷键,如下图: image.png
  • 如果要更改快捷键,可以自己匹配键位

OK,完毕。