在 VScode 中设置快捷键快速添加注释（文件头部、文件函数）

在编写代码的过程中，为了增加代码的可读性和维护性，我们通常会添加注释来解释代码的作用和功能。为了提高效率，我们可以在 VScode 中设置快捷键，以便快速添加注释，包括文件头部和函数注释。下面是详细的设置步骤：

1. 安装 "KoroFileHeader" 插件

首先，在 VScode 中搜索并安装名为 "KoroFileHeader" 的插件。你可以通过在扩展商店中搜索插件名称来找到并安装它。

2. 进入 VScode 设置页面

点击 VScode 左下角的设置图标，然后选择 "设置"，进入 VScode 的设置页面。

3. 编辑 setting.json 文件

在设置页面中，使用搜索框输入 "fileheader"，然后点击 "在 setting.json 中编辑"。

4. 添加设置项到 setting.json

在打开的 setting.json 文件中，将以下 JSON 代码添加到其中：

// 函数
"fileheader.cursorMode": {
    "description":"",
    "param":"",
    "return":""
},
// 头部
"fileheader.customMade": {
    "Author":"your name",
    "Date":"Do not edit",
    "LastEditors":"your name",
    "LastEditTime":"Do not Edit",
    "Description":"",
    "FilePath":"Do not Edit"
}

上述代码中的 "Author" 字段可以替换为你的名字或用户名。"FilePath" 字段会自动填充为当前文件的路径。

保存设置文件。

至此，设置已完成。

使用快捷键操作

1、添加文件头部注释。

• Windows：Ctrl + Win + I
• macOS：Ctrl + Cmd + I

效果如下：

2、添加函数注释。

• Windows：Ctrl + Win + T
• macOS：Ctrl + Cmd + T

效果如下：

使用上述快捷键，你可以快速添加文件头部和函数注释，提高代码编写的效率和规范性。

通过以上步骤，你可以在 VScode 中设置快捷键，并轻松地添加注释到你的代码中，使代码更易读和易于维护。