VS Code中自動爲Python文件添加頭部註釋

在實際編寫Python文件時，往往需要爲文件添加相關說明，例如文件名稱、文件作用、創建時間、作者信息、版本號等等。這些信息往往是固定模板的，因此希望有一種方式可以自動的爲我們添加上這些信息。下面介紹一種在VS Code中自動爲python文件添加頭部註釋的方法。

依次單擊菜單欄 “File”—“Preferences”—“User Snippets”，然後選擇python後會生成python.json文件，將該文件內容替換爲以下內容：

{
    "HEADER": {
        "prefix": "header",
        "body": [
            "#!/usr/bin/env python",
            "# -*- encoding: utf-8 -*-",
            "'''",
            "@文件        :$TM_FILENAME",
            "@說明        :",
            "@時間        :$CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
            "@作者        :張三",
            "@版本        :1.0",
            "'''",
            "",
            "$0"
        ],
    }
}

保存修改即可。

新建一個python文件，然後在頭部敲入header即可自動彈出下面的註釋：

如果需要修改模板，只需要修改對應的python.json文件即可。