PEP8 Python 格式指南
在撰寫程式碼時,應該遵循所使用的程式語言的慣例。
如果從一開始就學習正確的命名和格式慣例,閱讀別人編寫的程式碼會更容易,而且別人閱讀你的程式碼也會更輕鬆。
Python 在 PEP8 格式指南中定義了自己的慣例。PEP 代表「Python Enhancement Proposals」,這是所有 Python 語言增強和討論的地方。有很多 PEP 提案,都可以在 https://www.python.org/dev/peps/ 找到。
PEP8 是其中一個最早的提案,也是其中一個最重要的。它定義了程式碼的格式,並提供了一些如何以「Pythonic」的方式撰寫 Python 程式碼的規則。
你可以在這裡閱讀完整的內容:https://www.python.org/dev/peps/pep-0008/,但以下是一個快速摘要,可以讓你快速開始:
- 使用空格縮排,而非使用 TAB 鍵縮排
- 使用 4 個空格進行縮排
- Python 檔案的編碼為 UTF-8
- 程式碼的每行不要超過 80 個字元
- 每個陳述式獨立成行
- 函數、變數名稱和檔案名稱都使用小寫,單字之間使用底線分隔(snake_case)
- 類別名稱使用大寫開頭,單字之間使用大寫字母分隔(CamelCase)
- 套件名稱使用小寫,單字之間不使用底線分隔
- 不應更改的變數(常數)使用大寫
- 變數名稱應具有意義
- 添加有用的註解,但避免明顯的註解
- 在運算子周圍添加空格
- 不要使用不必要的空白
- 在函數之前添加一行空白
- 在類別的方法之間添加一行空白
- 在函數/方法內部,可以使用空白行將相關的程式碼區塊分隔開來以提高可讀性
tags: [“PEP8”, “Python”, “coding conventions”, “style guide”]