天天看點

【工具】vscode注釋插件koro1FileHeader

配置步驟

// 頭部注釋
"fileheader.customMade": {
    "Author": "OBKoro1", // 建立檔案的作者
    "Date": "Do not edit", // 檔案建立時間(不變)
    "LastEditors": "OBKoro1", // 檔案最後編輯者
    // 由于編輯檔案就會變更最後編輯時間,多人協作中合并的時候會導緻merge
    // 可以将時間顆粒度改為周、或者月,這樣沖突就減少很多。搜尋變更時間格式: dateFormat
    "LastEditTime": "Do not edit", // 檔案最後編輯時間
    // 輸出相對路徑,類似: /檔案夾名稱/src/index.js
    "FilePath": "Do not edit", // 檔案在項目中的相對路徑 自動更新
    // 插件會自動将光标移動到Description選項中 友善輸入 Description字段可以在specialOptions更改
    "Description": "", // 介紹檔案的作用、檔案的入參、出參。
    // custom_string_obkoro1~custom_string_obkoro100都可以輸出自定義資訊
    // 可以設定多條自定義資訊 設定個性簽名、留下QQ、微信聯系方式、輸入空行等
    "custom_string_obkoro1": "", 
    // 版權聲明 保留檔案所有權利 自動替換年份
    "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 使用者/公司名, All Rights Reserved. "
},
// 函數注釋
"fileheader.cursorMode": {
    "description": "", // 函數注釋生成之後,光标移動到這裡
    "param": "", // param 開啟函數參數自動提取 需要将光标放在函數行或者函數上方的空白行
    "return": "",
}      

使用快捷鍵

繼續閱讀