vscode自動註釋外掛的使用

LX2020發表於2024-03-10
VSCode

如果是工作中寫程式碼，經常會有一些註釋的規範，一次性寫很多檔案，就要把這部分內容複製來複制去，不太方便，因此就想著vscode是不是有什麼外掛可以用用，就發現了這樣一個外掛。

外掛是這個，搜尋koroFileHeader

image

這個安裝完之後最好自己配一下，不然不是很符合

進入設定頁面，搜尋FileHeader，找到下面的一個json
image

點選會跳到這裡，這個部分全都不要（是指fileheader的部分哈）
image

替換成下面的內容

    // 頭部註釋
    "fileheader.customMade": {
        "Author": "LX2035", // 建立檔案的作者
        "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 LX2035, All Rights Reserved. "
    },
    // 函式註釋
    "fileheader.cursorMode": {
        "description": "", // 函式註釋生成之後，游標移動到這裡
        "param": "", // param 開啟函式引數自動提取 需要將游標放在函式行或者函式上方的空白行
        "return": "",
    }

效果如下：
image

之後新建一個檔案，按下control + win + i，就是給檔案加上頭的註釋，按下control + win + t就是給函式加註釋，最終效果如下：

相關文章