前言
在實際開發中我們必須需要進行代碼注釋的編寫來提高代碼的可讀性和可維護性。但是使用簡單的代碼模板來進行粘貼復制顯然是一種低效率並且很low的方法，通過尋找，我發現vscode支持一款自動注釋函數和文件頭的插件koroFileHeader，這款插件可以設置固定的函數注釋模板和文件注釋模板來讓使用者快速的進行文件的注釋，在團隊維護代碼和進行代碼規范統一時可以大大的減少時間，從而提高工作的效率。
插件下載
插件可以直接在vscode的擴展中查找 koroFileHeader，但是有時候由於網絡的問題會查找不到軟件。如下圖所示：
所以可以進入vscode的插件網址https://marketplace.visualstudio.com/vscode 來進行插件的離線下載。具體如何進行插件的離線下載請自行百度。當我們安裝插件重啟后，vscode的擴展工具箱就有這個圖標。
插件配置
koroFileHeader支持許多功能，但是不是所有功能都是需要，我們關注往往是如何配置注釋內容和注釋的一些選項。所以可以跟隨本教程無腦的進行配置，一步一步的執行，一般是不會出現問題。
- 快捷鍵
ctrl+,，打開設置，在設置中搜索fileheader
- 在進入配置文件后，得到一堆東西，其實不一定要搞懂，其實這就是配置文件罷了，注意這上面有兩個重要的配置
Fileheader:Cursor Mode和Fileheader:Cursor Mode
-
分別點擊這兩個，則在
settings.json配置文件的最后會生成下面代碼。"fileheader.cursorMode": { //這部分是函數頭的配置 }, "fileheader.customMade": { //這部分是文件頭的配置 } -
而
setting.json中"fileheader.configObj":{.....}中的內容就是配置的內容，下面我以C語言注釋配置進行簡單的說明。配置語言的格式，可以進行自定義語言格式的配置。這樣生成的代碼便會以你設置的頭來產生模板。
-
接下去就是配置函數頭和文件頭的注釋模板。大家可以參考我寫的模板整理自己需要的模板。![image-20210909023347647]
"fileheader.cursorMode": { "Funticon name": "Please write your function name here", "Berif": "Briefly describe the function of your function", "Author": "Krone", "Data": "Do not edit", "Note": "Need note condition", "param":"", "result":"", "Test_result":"Function self test result ok or fault" }, "fileheader.customMade": { "Copyright": "", "file name": "File name", "Data":"Do not edit", "LastEditor": "", "LastData":"", "Describe":"" } -
最后配置幾個選項就成功了，
"openFunctionParamsCheck": true,這個選項開啟可以自動檢查函數的參數然后生成函數的參數列表，是我覺的比較便利的選項。還有Data是內部的字段，要讓插件自動寫入時鍾，那么就寫Do not edit， 還有functionWideNum可以使得代碼的排列更整齊。這里選擇一個值后設置wideSame為true即可。最后的效果圖如下，這樣函數和文件的功能標注就一目了然。
關於快捷鍵，插件安裝的默認快捷鍵為
Ctrl + Alt +i 文件頭部注釋快捷鍵
Ctrl + Alt + t 函數注釋
但是我個人覺這個有點不是很符合手指的行為，所以我修改為shift+1和shift+2，這樣注釋老代碼就快的飛起。