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

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

# 使用效果：

# 简介

1. 文件头部添加注释:

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

2. 在光标处添加函数注释:

   • 在光标处自动生成一个注释模板
   • 支持用户高度自定义注释选项
   • 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t
   • 快捷键不可用很可能是被占用了,参考这里

3. 支持一键添加佛祖保佑永无BUG、神兽护体等注释图案

   

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

# 安装

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

# 使用

1. 文件头部注释：

   在当前编辑文件中使用快捷键:window：ctrl+alt+i/mac：ctrl+cmd+i,即可生成文件头部注释。

2. 函数注释：

   • 将光标放在函数行或者将光标放在函数上方的空白行
   • 使用快捷键window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函数注释。
   • 事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。

# 注释模板的设置

# wiki文档

更新日志

支持语言

插件设置/配置

配置字段

常见问题

# 支持功能：

• 支持一键添加佛祖保佑永无BUG、神兽护体等注释图案: 写代码不骚是不行的 ^_^

• 自定义注释模板信息,自动更新最后编辑时间，最后编辑人。

• 支持几乎所有语言的注释形式

• 自定义注释符号：即使插件不支持的语言，也可以自己定制。

• 检测文件头部没有注释, 自动添加头部注释功能，配合自动添加头部注释黑名单，麻麻再也不用担心我忘记加注释了.

• 生成头部注释时，自动添加文件相对于当前项目的文件路径

• 头部注释等宽功能，提高文件头部注释的颜值。

• 头部注释第几行插入,类似PHP第一行被占用了，通过设置，可以在第二行里面插入。

• 在头部注释之前、之后插入一段内容，类似python的环境声明: #!/usr/bin/env python

• 特殊字段自定义，类似博客的时间字段有特殊要求。

• 在头部注释/函数注释中输出一段自定义信息，可以是版权声明、个性签名、空行等。

• 注释时间格式化

• 匹配到换行自动添加注释符号

• 生成头部注释/函数注释时自动移动光标到Description所在行.

• 文件diff检查：检测只变更LastEditors和LastEditTime，将回滚该文件，减少无意义的提交。

• 新建文件自动添加头部注释

• 自动添加头部注释-项目黑名单

# Auto Commit

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

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

设置也超方便的，传送门

# 最后

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

前端进阶积累、公众号、GitHub

# 点个Star支持我一下~