一个支持多语言,读取用户设置的自定义模板,通过快捷键添加文件头部注释、在光标处添加函数注释的VsCode插件,求star⭐️
Switch branches/tags
Nothing to show
Clone or download

README.md

koroFileHeader

一个支持多语言,读取用户设置的自定义模板,通过快捷键添加文件头部注释、在光标处添加函数注释的VsCode插件

language

简体中文 | English

一些文档

支持语言

插件设置/配置

更新日志

常见问题

简介

  1. 文件头部添加注释:

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

    • 在光标处自动生成一个注释模板,下方有栗子
    • 支持用户高度自定义注释选项
    • 快捷键:windowctrl+alt+t,macctrl+cmd+t
    • 快捷键不可用很可能是被占用了,参考这里
  3. 支持不同语言的注释格式,如下。

安装

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

使用

  1. 栗子:

  2. 文件头部注释:

    在当前编辑文件中使用快捷键:windowctrl+alt+t/macctrl+cmd+t,即可生成文件头部注释。

  3. 函数注释:

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

注释模板的设置

设置也超方便的,传送门

最后

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

博客前端积累文档公众号GitHub