当前位置: 首页 > news >正文

工具分享: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、微信联系方式、输入空行等等

  • 支持用户高度自定义注释选项, 适配各种需求的注释形式。

  • 保存文件的时候,自动更新最后的编辑时间和编辑人

  • 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

http://www.lryc.cn/news/351151.html

相关文章:

  • 水面漂浮物生活垃圾识别检测系统
  • 通过python读取并发送二进制文件到串口
  • 前端笔记-day07
  • 【MySQL精通之路】INFORMATION_SCHEMA库-INNODB_METRICS表
  • React Native 之 定义全局状态管理库(九)
  • java线程池实战应用总结
  • 部署 harbor 创建私有项目
  • 在Linux系统中解决Java生成海报文字乱码和缺少字体文件的问题
  • 升级版网创教程wordpress插件自动采集并发布
  • MySQL 视图(1)
  • 在排序数组中查找元素的一个位置和最后一个位置-力扣
  • 系统分析师-案例分析-数据库
  • 【RabbitMQ】使用SpringAMQP的消息队列(Hello Word)和工作队列(Work Queue)
  • 项目集成SkyWalking,基于k8s搭建
  • mysql-差异备份流程
  • 基于动态规划算法的DNA序列比对函数,给出两条序列(v和w)的打分矩阵
  • Tailwind CSS快速入门
  • Postman使用技巧
  • sqli-labs靶场
  • 基于springboot的大创管理系统
  • 常用torch.nn
  • 力扣226.翻转二叉树101.对称二叉树
  • word如何按照原本页面审阅文档
  • 前端基础入门三大核心之HTML篇:探索WebAssembly —— 开启网页高性能应用新时代
  • NDIS小端口驱动(四)
  • 用户态网络缓冲区设计
  • Linux运维工程师基础面试题整理(三)
  • 基于单片机与传感器技术的汽车起动线路设计
  • C#如何通过反射获取外部dll的函数
  • 从零开始傅里叶变换