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

server/2024/9/24 2:07:12/

他是有官方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.ppmy.cn/server/42951.html

相关文章

JMH 微基准测试(性能测试)

写本文主要是简单记录一下JMH的使用方式。JMH全名是Java Microbenchmark Harness,主要为在jvm上运行的程序进行基准测试的工具。作为一个开发人员,在重构代码,或者确认功能的性能时,可以选中这个工具。 本文场景:代码重…

Elasticsearch集群部署以及认证配置

目录 文档地址: 源码安装-环境准备: 解压ES源码包 修改ES集群配置文件 安全认证操作步骤 在192.168.95.174 node-01节点操作 将节点node-01上生成的两个文件拷贝到另外的节点 启动ES集群服务 1、创建用户 2、启动 设置es密码 用过用户名密码验…

Linux 内核开发 27 POSIX共享内存

Linux 内核开发 27 POSIX共享内存 1.定义 支持 POSIX 共享内存,linux 内核使用的是通过一个名为tmpfs的特殊文件系统来实现内存共享,并且将文件系统挂载在rootfs的/dev/shm上。 这种实现与linux 文件系统api 相互一致,所以每个文件都有inod…

接口测试及接口测试常用的工具详解

🍅 视频学习:文末有免费的配套视频可观看 首先,什么是接口呢? 接口一般来说有两种,一种是程序内部的接口,一种是系统对外的接口。 系统对外的接口:比如你要从别的网站或服务器上获取资源或信息…

华为CE6851-48S6Q-HI升级设备版本及补丁

文章目录 升级前准备工作笔记本和交换机设备配置互联地址启用FTP设备访问FTP设备升级系统版本及补丁 升级前准备工作 使用MobaXterm远程工具连接设备,并作为FTP服务器准备升级所需的版本文件及补丁文件 笔记本和交换机设备配置互联地址 在交换机接口配置IP&#…

Stable Diffusion【提示词】【视觉设计】:多面板墙壁艺术

大模型:RealVisXL V4.0 提示词 Multi panel wall art of [Subject], style of digital art, living room, high definition, 8k [主题]的多面板墙壁艺术,数字艺术风格,客厅,高清,8k 参数设置 大模型:Re…

Fastjson漏洞之CVE-2017-18349

前言: 要想理解漏洞原理,首先看看Fastjson是什么,具体用来做什么才能更好的找到可以利用的场景: Fastjson 是一个由阿里巴巴开发的 Java 语言实现的高性能 JSON 解析器和生成器。它具有以下特点: 快速:Fastjson 在序列…

【Spring Boot】深度复盘在开发搜索引擎项目中重难点的整理,以及遇到的困难和总结

💓 博客主页:从零开始的-CodeNinja之路 ⏩ 收录文章:【Spring Boot】深度复盘在开发搜索引擎项目中重难点的整理,以及遇到的困难和总结 🎉欢迎大家点赞👍评论📝收藏⭐文章 目录 什么是搜索引…