在vscode中用于生成文件头部注释和函数注释的插件,经过多版迭代后,插件:支持所有主流语言,功能强大,灵活方便,文档齐全,食用简单!觉得插件不错的话,就给个Star⭐️吧~
-
文件头部添加注释:
- 在文件开头添加注释,记录文件信息
- 支持用户高度自定义注释选项
- 保存文件的时候,自动更新最后的编辑时间和编辑人
- 快捷键:
window
:ctrl+alt+i
,mac
:ctrl+cmd+i
-
在光标处添加函数注释:
- 在光标处自动生成一个注释模板,下方有栗子
- 支持用户高度自定义注释选项
- 快捷键:
window
:ctrl+alt+t
,mac
:ctrl+cmd+t
- 快捷键不可用很可能是被占用了,参考这里
-
自定义注释符号,再也不用担心冷门语言插件不支持了!
在 Vscode 扩展商店中搜索koroFileHeader
,点击安装即可。
-
文件头部注释:
在当前编辑文件中使用快捷键:
window
:ctrl+alt+t
/mac
:ctrl+cmd+t
,即可生成文件头部注释。 -
函数注释:
- 将光标放在函数行或者将光标放在函数上方的空白行
- 使用快捷键
window
:ctrl+alt+t
,mac
:ctrl+cmd+t
,即可生成函数注释。 - 事实上,函数注释在文件的任意位置都可生成,这里需要自己控制。
设置也超方便的,传送门
- 自定义注释模板信息,自动更新最后编辑时间,最后编辑人。
- 支持几乎所有语言的注释形式
- 自定义注释符号,即使插件不支持的语言,也可以自己定制。
- 自动添加头部注释功能,配合自动添加头部注释黑名单,麻麻再也不用担心我忘记加注释了。
- 头部注释第几行插入,类似
PHP
第一行被占用了,通过设置,可以在第二行里面插入。 - 注释时间格式化
- 在头部注释之前、之后插入一段内容,类似
python
的环境声明:#!/usr/bin/env python
- commit hooks检测文件只有最后编辑人/最后编辑时间变更的情况下,将其恢复,并取消
commit
- 特殊字段自定义,类似博客的时间字段有特殊要求。
- 头部注释中输出一段自定义信息,可以是版权声明、个性签名等内容。
- 匹配到换行自动添加注释符号, 生成头部注释自动移动光标到`Description所在行.
如果觉得还不错的话,就给个 Star ⭐️ 鼓励一下我吧~