1. 程式人生 > 實用技巧 >vscode快速新增檔案頭部註釋和函式註釋

vscode快速新增檔案頭部註釋和函式註釋

安裝外掛並配置

vscode安裝koroFileHeader外掛,ctrl+shift+p 搜尋setting,然後搜尋FileHeader點選並且進入setting介面。

新增以下配置項:

	//快速新增檔案頭部註釋和函式註釋
    "fileheader.configObj": {
        "createFileTime": true, //設定為true則為檔案新建時候作為date,否則註釋生成時間為date
        "autoAdd": true, //自動生成註釋
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": true //設定自定義註釋可用
        },
    },
    "fileheader.cursorMode": {
        "description": "",
        "param ": "",
        "return": ""
    },
    "fileheader.customMade": {
        "Description": "", //檔案內容描述
        "Author": "liutq", //編輯人
        "Date": "Do not edit", //時間
        "LastEditTime": "Do not edit",
        "LastEditors": "liutq",
        "Reference": ""
    },

快捷鍵

檔案頭部添加註釋快捷鍵:

windows:ctrl+alt+i
mac:ctrl+cmd+i

在游標處新增函式註釋快捷鍵:

window:ctrl+alt+t
mac:ctrl+cmd+t