# koroFileHeader-VSCode文件头部注释生成

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

# 使用效果:

example.gif

# 简介

  1. 文件头部添加注释:

    • 在文件开头添加注释,记录文件信息/文件的传参/出参等
    • 支持用户高度自定义注释选项, 适配各种需求和注释。
    • 保存文件的时候,自动更新最后的编辑时间和编辑人
    • 快捷键:windowctrl+alt+i,macctrl+cmd+i
  2. 在光标处添加函数注释:

    • 在光标处自动生成一个注释模板
    • 支持用户高度自定义注释选项
    • 快捷键:windowctrl+alt+t,macctrl+cmd+t
    • 快捷键不可用很可能是被占用了,参考这里
  3. 支持一键添加佛祖保佑永无BUG、神兽护体等注释图案

  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,帮助你把首页的绿色格子填满

autoCommit演示

设置也超方便的,传送门

# 最后

如果觉得还不错的话,就给个 Star ⭐️ 鼓励一下我吧~

前端进阶积累公众号GitHub

# 点个Star支持我一下~

最后更新时间: 5/14/2020, 7:14:27 PM