1. 程式人生 > 程式設計 >VSCode中自動為Python檔案新增頭部註釋

VSCode中自動為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檔案即可。

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。