配置
setting.json
// 頭部注釋
"fileheader.customMade": {
"Author": "OBKoro1", // 創(chuàng)建文件的作者
"Date": "Do not edit", // 文件創(chuàng)建時間(不變)
"LastEditors": "OBKoro1", // 文件最后編輯者
// 由于編輯文件就會變更最后編輯時間,多人協(xié)作中合并的時候會導致merge
// 可以將時間顆粒度改為周瘩例、或者月蒲拉,這樣沖突就減少很多。搜索變更時間格式: dateFormat
"LastEditTime": "Do not edit", // 文件最后編輯時間
// 輸出相對路徑忽冻,類似: /文件夾名稱/src/index.js
"FilePath": "Do not edit", // 文件在項目中的相對路徑 自動更新
// 插件會自動將光標移動到Description選項中 方便輸入 Description字段可以在specialOptions更改
"Description": "", // 介紹文件的作用真朗、文件的入?yún)ⅰ⒊鰠ⅰ? // custom_string_obkoro1~custom_string_obkoro100都可以輸出自定義信息
// 可以設(shè)置多條自定義信息 設(shè)置個性簽名甚颂、留下QQ蜜猾、微信聯(lián)系方式、輸入空行等
"custom_string_obkoro1": "",
// 版權(quán)聲明 保留文件所有權(quán)利 自動替換年份
"custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 用戶/公司名, All Rights Reserved. "
},
// 函數(shù)注釋
"fileheader.cursorMode": {
"description": "", // 函數(shù)注釋生成之后振诬,光標移動到這里
"param": "", // param 開啟函數(shù)參數(shù)自動提取 需要將光標放在函數(shù)行或者函數(shù)上方的空白行
"return": "",
}
快捷鍵
ctrl + cmd(win)+ I 文件頭部注釋(在文件任意位置)
ctrl + cmd(win)+ T 函數(shù)注釋(在函數(shù)行或者函數(shù)上一空白行)