工具分享:VsCode注释神器,koro1FileHeader

简介: 工具分享:VsCode注释神器,koro1FileHeader

他是有官方Wiki的。

https://github.com/OBKoro1/koro1FileHeader/wiki/

项目在GitHub上开源。以下摘录部分wiki,用作介绍分享在这里插入代码片

如何找到setting.json设置模板
  1. 简单的输入命令
  • 打开VSCode命令面板: mac: command + p window: ctrl + p
  • 输入> Open Settings(注意>后面有一个空格)

  1. 从设置中打开

首选项 > 设置 > 搜索fileheader > 在右侧中贴上配置 > 做简单的更改

快捷键使用

文件头部注释快捷键
  • 记录文件信息/文件的传参/出参,设置个性签名、留下QQ、微信联系方式、输入空行等等
文件头部注释快捷键
  • 记录文件信息/文件的传参/出参,设置个性签名、留下QQ、微信联系方式、输入空行等等
  • windowctrl+win+i,macctrl+cmd+i, linux: ctrl+meta+i,Ubuntu: ctrl+super+i
  • 将光标放在函数行或者将光标放在函数上方的空白行。
  • 自动解析函数参数,生成函数参数注释。
  • 快捷键:windowctrl+win+t,macctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t
多行函数参数鼠标选中后函数声明后按快捷键自动提取
  1. 鼠标左键选择多行函数声明区域,函数声明区域尽量精准
  2. 按函数注释快捷键

函数注释光标移动到下一行,快速添加函数参数描述

window: win+y, mac: cmd+y, linux: meta+y

生成函数注释之后,使用快捷键移动鼠标到下一行,快速为函数参数添加描述。

可能有很多参数,需要移动鼠标一个一个添加的话,操作起来有点麻烦。

快捷键不可用的问题

快捷键不可用很可能是被占用了,参考这里

关闭自动添加头部注释

插件默认打开自动添加头部注释: 关闭自动添加头部注释

或许你可以对自动添加头部注释做一些限制:

  • 代码行数:文件多少行以内允许自动添加
  • 白名单与黑名单:比如只禁止.json,只允许.js文件添加
  • 项目的黑名单:添加公司的项目名,禁止公司项目自动添加头部注释。
  • 文件夹的黑名单,比如node_modules文件夹禁止、README.md文件禁止



分享一个有趣的 学习链接:https://xxetb.xet.tech/s/HY8za


目录
相关文章
|
2月前
|
IDE C# 开发工具
一个开源轻量级的C#代码格式化工具(支持VS和VS Code)
一个开源轻量级的C#代码格式化工具(支持VS和VS Code)
102 6
|
2月前
|
API 开发工具 C++
【专栏:工具与技巧篇】使用代码编辑器(VS Code/Sublime Text)提升开发效率
【4月更文挑战第30天】在VS Code与Sublime Text两大流行代码编辑器中,开发者可借助其高效特性提升编程效率。VS Code拥有丰富的插件生态、内置Git集成、强大的调试工具、智能提示和多文件导航功能。Sublime Text则以其轻量级、快速响应、多光标编辑及自定义构建系统见长。学习编辑器的键盘快捷键、自定义配置、使用内置终端以及键绑定和宏,将助开发者进一步提高开发效率。选择适合自己的编辑器并不断适应新技术是提升开发工作流的关键。
|
2月前
|
前端开发 JavaScript 开发工具
前端开发工具VS Code深度探索
前端开发工具VS Code深度探索
46 1
|
2月前
VSCode插件分享--免费的ER工具
VSCode插件分享--免费的ER工具
37 0
|
9月前
|
JavaScript 前端开发 Windows
VScode的注释和标题,标签,img的src属性(如何网页上插入图片)(Mac如何开启js控制台)(如何免费复制网页中的文字)
VScode的注释和标题,标签,img的src属性(如何网页上插入图片)(Mac如何开启js控制台)(如何免费复制网页中的文字)
|
2月前
|
JSON JavaScript 数据格式
vscode添加自定义注释
vscode添加自定义注释
232 0
|
2月前
|
JavaScript 前端开发 Java
用超级厉害的VS Code工具来嗨皮编程吧!
用超级厉害的VS Code工具来嗨皮编程吧!
43 0
|
7月前
|
小程序 PHP Perl
vscode设置php自定义注释格式
写代码一般的注释都是有格式的,方便自己和他人阅读代码,多人开发的时候,也能更快的找到这部分代码是由谁来编写的。 好的代码注释确实是一个好习惯,但是,有的时候就是这玩意有敲起来有点费劲~
139 0
|
11月前
|
PHP
vscode添加PHP代码注释的插件及设置教程
在vscode中点击扩展-->安装插件koroFileHeader
395 0
|
11月前
|
网络协议 Ubuntu Linux
闲置iPad Pro打造真正的生产力工具!使用vscode编程写代码
闲置iPad Pro打造真正的生产力工具!使用vscode编程写代码
616 0