VsCode 添加文件头部注释和函数注释[koroFileHeader]

简介: koroFileHeader在vscode中用于生成文件头部注释和函数注释的插件,经过多版迭代后,插件:支持所有主流语言,灵活方便,文档齐全,食用简单!觉得插件不错的话,就给个Star⭐️吧~文件头部添加注释:在文件开头添加注释,记录文件信息/文件的传参/出参等支持用户高度自定义注释选项, 适配各种需求和注释。保存文件的时候,自动更新最后的编辑时间和编辑人快捷键:window:ctrl+alt+i,mac:ctrl+cmd+i

koroFileHeader

在vscode中用于生成文件头部注释和函数注释的插件,经过多版迭代后,插件:支持所有主流语言,灵活方便,文档齐全,食用简单!觉得插件不错的话,就给个Star⭐️吧~

使用效果:

image.png

简介

  1. 文件头部添加注释:
  • 在文件开头添加注释,记录文件信息/文件的传参/出参等
  • 支持用户高度自定义注释选项, 适配各种需求和注释。
  • 保存文件的时候,自动更新最后的编辑时间和编辑人
  • 快捷键:windowctrl+alt+i,macctrl+cmd+i
  1. 在光标处添加函数注释:
  • 在光标处自动生成一个注释模板
  • 支持用户高度自定义注释选项
  • 快捷键:windowctrl+alt+t,macctrl+cmd+t
  • 快捷键不可用很可能是被占用了,参考这里
  1. 支持一键添加佛祖保佑永无BUG、神兽护体等注释图案

image.png

4.查看更多功能,以及有更多需求可以给我提issue

安装

在 Vscode 扩展商店中搜索koroFileHeader,点击安装即可。

使用

  1. 文件头部注释:
    在当前编辑文件中使用快捷键:windowctrl+alt+i/macctrl+cmd+i,即可生成文件头部注释。
  2. 函数注释:
  • 将光标放在函数行或者将光标放在函数上方的空白行
  • 使用快捷键windowctrl+alt+t,macctrl+cmd+t,即可生成函数注释。
  • 事实上,函数注释在文件的任意位置都可生成,这里需要自己控制。

注释模板的设置

wiki文档

更新日志

支持语言

插件设置/配置

配置字段

常见问题

支持功能:

Auto Commit

推荐一个新开源的插件:Auto Commit

这是一个用于Git自动commit的VSCode插件,它可以用来补充之前忘记提交commit,帮助你把首页的绿色格子填满

image.png

设置也超方便的。


目录
相关文章
|
7月前
|
前端开发
【HTML专栏2】VSCode的使用(新建HTML文件)
【HTML专栏2】VSCode的使用(新建HTML文件)
525 0
|
4月前
|
Android开发
Vscode中注释变成繁体的解决方法
这篇文章提供了两种解决Vscode中注释变成繁体字的方法:第一种是通过设置语言模式来更改显示语言;第二种是更改文件的编码格式,如在UTF-8和GBK之间切换,以解决乱码问题。
Vscode中注释变成繁体的解决方法
|
4月前
|
机器学习/深度学习 存储 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中的文件
|
4月前
|
开发工具
如何修改Vscode查看源代码管理版本变动文件的查看方式
这篇文章介绍了如何在VSCode中通过源代码管理插件修改查看源代码版本变动文件的方式,提供了树形视图和列表视图两种查看方法,并说明了如何通过设置选项来切换查看方式,帮助用户根据自己的喜好更高效地查看和管理代码变动。
如何修改Vscode查看源代码管理版本变动文件的查看方式
|
4月前
|
Windows
Windows——如何在文件资源管理器地址栏快速打开Vscode
Windows——如何在文件资源管理器地址栏快速打开Vscode
91 4
|
4月前
|
存储 Java 开发工具
【Azure Developer】VS Code运行Java 版Azure Storage SDK操作Blob (新建Container, 上传Blob文件,下载及清理)
【Azure Developer】VS Code运行Java 版Azure Storage SDK操作Blob (新建Container, 上传Blob文件,下载及清理)
|
6月前
|
JSON Ubuntu JavaScript
工具分享:VsCode注释神器,koro1FileHeader
工具分享:VsCode注释神器,koro1FileHeader
211 3
|
5月前
|
前端开发 JavaScript 开发工具
vscode教程(含使用技巧、保存时自动格式化文件等设置)
vscode教程(含使用技巧、保存时自动格式化文件等设置)
437 0
|
6月前
|
JavaScript
VScode格式化vue文件--避免html属性换行
VScode格式化vue文件--避免html属性换行
926 0
|
7月前
|
Windows
vscode 终端无法执行npm、cnpm命令的解决办法,npm : 无法将“npm”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写,如果包括路径,请确保路径正确,然后再试
vscode 终端无法执行npm、cnpm命令的解决办法,npm : 无法将“npm”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写,如果包括路径,请确保路径正确,然后再试
1749 0