vscode的KoroFileHeader插件使用

1 KoroFileHeader

KoroFileHeader是一款4星半的插件，可以在vscode扩展商店里搜索koroFileHeader安装。该插件的主要功能是用于注释的快捷添加。

koroFileHeader的主要命令如下： - `extension.fileheader` - `extension.cursorTip`

2 文件头部添加注释

文件头部添加注释:

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

在当前编辑文件中使用快捷键:window：ctrl+alt+i/mac：ctrl+cmd+i,即可生成文件头部注释，该命令效果如下：

/*
 * @Author: your name
 * @Date: 2021-02-09 13:42:46
 * @LastEditTime: 2021-02-09 14:23:09
 * @LastEditors: Please set LastEditors
 * @Description: In User Settings Edit
 * @FilePath:
 */

3 函数头部添加注释

在光标处添加函数注释:

• 在光标处自动生成一个注释模板, 自动解析函数参数，生成函数参数注释。
• 支持用户高度自定义注释选项
• 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t,linux: ctrl+meta+t

将光标放在函数行或者将光标放在函数上方的空白行，再使用快捷键window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函数注释，该命令效果如下：

/**
 * @description: 
 * @param {*}
 * @return {*}
 */

4 快捷键无法使用的情况

快捷键不可用很可能是快捷键冲突，参考这里。

参考

[1] OBKoro1.koro1FileHeader.github.[OL].[2021.02.09].https://github.com/OBKoro1/koro1FileHeader.