一個(gè)讀取用戶自定義模板夷蚊，通過(guò)快捷鍵添加文件頭部注釋、在光標(biāo)處添加函數(shù)注釋的
VsCode插件
簡(jiǎn)介
-
文件頭部添加注釋:
- 在文件開(kāi)頭添加注釋议经，記錄文件信息
- 支持用戶高度自定義注釋選項(xiàng)
- 保存文件的時(shí)候，自動(dòng)更新最后的編輯時(shí)間和編輯人
- 快捷鍵：
window：ctrl+alt+i,mac：ctrl+cmd+i
-
在光標(biāo)處添加函數(shù)注釋:
- 在光標(biāo)處自動(dòng)生成一個(gè)注釋模板，下方有栗子
- 支持用戶高度自定義注釋選項(xiàng)
- 快捷鍵：
window：ctrl+alt+t,mac：ctrl+cmd+t - 快捷鍵不可用很可能是被占用了,參考這里
支持不同語(yǔ)言的注釋格式掘宪，如下。
支持注釋格式：
/**/形式：Javascript/Java/go/C++/C'''形式：python``形式：
html'形式：vba
安裝
在 Vscode 擴(kuò)展商店中搜索koroFileHeader,點(diǎn)擊安裝即可攘烛。
使用
-
文件頭部注釋：
在當(dāng)前編輯文件中使用快捷鍵:
window：ctrl+alt+t/mac：ctrl+cmd+t,即可生成文件頭部注釋魏滚。 -
函數(shù)注釋：
- 將光標(biāo)放在函數(shù)行或者將光標(biāo)放在函數(shù)上方的空白行
- 使用快捷鍵
window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函數(shù)注釋坟漱。 - 事實(shí)上鼠次，函數(shù)注釋在文件的任意位置都可生成，這里需要自己控制芋齿。
注釋模板的設(shè)置
-
默認(rèn)配置:
在用戶首選項(xiàng)中搜索
fileheader须眷，默認(rèn)配置為："fileheader.customMade": {} // 頭部注釋 "fileheader.cursorMode": {} // 函數(shù)注釋 復(fù)制代碼用戶未設(shè)置的情況下，頭部注釋和函數(shù)注釋模板為：
image<figcaption style="display: block; text-align: center; font-size: 1rem; line-height: 1.6; color: rgb(144, 144, 144); margin-top: 2px;"></figcaption>
-
自定義模板：
在用戶設(shè)置中沟突，搜索
fileheader-
復(fù)制默認(rèn)配置+修改配置,重啟生效
[圖片上傳失敗...(image-9a3f56-1586483121967)]
<figcaption style="display: block; text-align: center; font-size: 1rem; line-height: 1.6; color: rgb(144, 144, 144); margin-top: 2px;"></figcaption>
如上設(shè)置花颗，生成注釋：
// 文件頭部注釋 /* * @Description: * @version: * @Company: BAT * @Author: OBKoro1 * @Date: 2018-10-15 20:59:57 * @LastEditors: OBKoro1 * @LastEditTime: 2018-10-15 20:59:57 */ // 函數(shù)注釋 /** * @name: * @test: test font * @msg: * @param {type} * @return: */ 復(fù)制代碼
自動(dòng)更新最后編輯時(shí)間、編輯人：
要開(kāi)啟這個(gè)功能惠拭，需要在首選項(xiàng)設(shè)置中填寫對(duì)應(yīng)的屬性：
"fileheader.customMade": {
"Date": "Do not edit", // 文件創(chuàng)建時(shí)間(不變)
"LastEditors": "OBKoro1", // 文件最后編輯者
"LastEditTime": "Do not edit" // 文件最后編輯時(shí)間
}
// 不填寫對(duì)應(yīng)屬性即關(guān)閉對(duì)應(yīng)功能
復(fù)制代碼
自動(dòng)更新編輯時(shí)間
示例:
