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.