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

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

556461733434d9e33e4b69c98500085a.jpeg

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

1. 安装 "KoroFileHeader" 插件

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

搜索插件

2. 进入 VScode 设置页面

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

进入设置页面

3. 编辑 setting.json 文件

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

编辑 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

效果如下:

image.png

2、添加函数注释。

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

效果如下:

image.png

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

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

目录
相关文章
|
1天前
|
Linux C++ iOS开发
vs code常见的查找快捷键大全
本文来自 frozencola 技术日志,介绍了 VS Code 中常用的查找快捷键,包括快速打开文件、文件资源管理器、全局搜索、查找符号、查找文件中的文本、查找并替换、文件导航和使用命令面板。掌握这些快捷键可以显著提升开发效率。
14 3
|
1天前
|
C++
vs code常见的查找快捷键大全
【11月更文挑战第1天】本文介绍了 VS Code 中的基本查找和替换操作,包括在当前文件中查找(Ctrl + F)、查找替换(Ctrl + H)、查找下一个(F3)和查找上一个(Shift + F3)。还涵盖了在多个文件中查找(Ctrl + Shift + F)和查找替换(Ctrl + Shift + H),以及符号查找相关操作,如转到符号(Ctrl + T)和在文件中查找符号(Ctrl + Shift + O)。这些快捷键和功能帮助用户高效地管理和编辑代码。
|
3月前
|
Android开发
Vscode中注释变成繁体的解决方法
这篇文章提供了两种解决Vscode中注释变成繁体字的方法:第一种是通过设置语言模式来更改显示语言;第二种是更改文件的编码格式,如在UTF-8和GBK之间切换,以解决乱码问题。
Vscode中注释变成繁体的解决方法
2022最新最详细必成功的在Vscode中设置背景图、同时解决不受支持的问题
这篇文章提供了在VScode中设置背景图的详细步骤,包括下载background插件、编辑setting.json文件、配置背景样式,并解决了设置后出现的不支持提示的问题。
2022最新最详细必成功的在Vscode中设置背景图、同时解决不受支持的问题
|
3月前
|
机器学习/深度学习 存储 Linux
【机器学习 Azure Machine Learning】使用VS Code登录到Linux VM上 (Remote-SSH), 及可直接通过VS Code编辑VM中的文件
【机器学习 Azure Machine Learning】使用VS Code登录到Linux VM上 (Remote-SSH), 及可直接通过VS Code编辑VM中的文件
|
3月前
|
开发工具
如何修改Vscode查看源代码管理版本变动文件的查看方式
这篇文章介绍了如何在VSCode中通过源代码管理插件修改查看源代码版本变动文件的方式,提供了树形视图和列表视图两种查看方法,并说明了如何通过设置选项来切换查看方式,帮助用户根据自己的喜好更高效地查看和管理代码变动。
如何修改Vscode查看源代码管理版本变动文件的查看方式
|
3月前
|
Windows
Windows——如何在文件资源管理器地址栏快速打开Vscode
Windows——如何在文件资源管理器地址栏快速打开Vscode
71 4
Vscode设置标签页多行显示
这篇文章提供了在VSCode中设置标签页多行显示的方法,以提高编辑效率。
Vscode设置标签页多行显示
|
3月前
|
编译器 C++
VS Code设置C++编译器路径
VS Code设置C++编译器路径
42 0
|
3月前
|
存储 Java 开发工具
【Azure Developer】VS Code运行Java 版Azure Storage SDK操作Blob (新建Container, 上传Blob文件,下载及清理)
【Azure Developer】VS Code运行Java 版Azure Storage SDK操作Blob (新建Container, 上传Blob文件,下载及清理)