需求背景
編寫完成一個程式碼原始檔，他人想檢視這個檔案是誰編寫的？、什麼時候建立的？、最後一個編輯時間？等。 如果檔案所有者不寫的話，你無法知道這些資訊。
我想在檔案快速新增自定義頭部資訊以及函式註釋資訊，提供給自己和他人查詢方便。當然我們可以一個一個字元敲上去，但是這種效率不高且容易忘記。在VSCode上剛好有一個外掛可以滿足需求：koroFileHeader
外掛安裝
在VSCode應用商店下載koroFileHeader外掛，重啟VSCode。 接著設定註釋模板配置文件：
在 setting.json 中新增如下配置資訊
//自動生成註解
"fileheader.configObj": {
"createFileTime": true, //設定為true則為檔案新建時候作為date，否則註釋生成時間為date
"autoAdd": true, //自動生成註釋
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": true //設定自定義註釋可用
}
},
//頭部註釋(ctrl + win + t)
"fileheader.customMade": {
"Description": "",
"Author": "your name",
"version": "",
"Date": "Do not edit",
"LastEditors": "your name",
"LastEditTime": "Do not Edit"
},
//方法(函式)註釋(ctrl + win + i)
"fileheader.cursorMode": {
"description": "",
"param": "", // param 開啟函式引數自動提取 需要將游標放在函式行或者函式上方的空白行
"return": ""
},
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue"
重啟VSCode後立即生效。
新建檔案會自動生成頭部註釋資訊，支援手動快捷鍵新增註釋資訊。
- ctrl + win + t : 快速生成函式註釋資訊
- ctrl + win + i : 快速生成檔案頭部註釋資訊
