python 的程式設計規範

yarking207發表於2017-09-18
  • 每個縮排層級使用4個空格。
  • 每行最多79個字元。
  • 頂層的函式或類的定義之間空兩行。
  • 採用ASCII或UTF-8編碼檔案。
  • 在檔案頂端,註釋和文件說明之下,每行每條import語句只匯入一個模組,同時要按標準庫、第三方庫和本地庫的匯入順序進行分組。
  • 在小括號、中括號、大括號之間或者逗號之前沒有額外的空格。
  • 類的命名採用駱駝命名法,如CamelCase;異常的定義使用Error字首(如適用的話);函式的命名使用小寫字元,如separated_by_underscores;用下劃線開頭定義私有的屬性或方法,如_private。



     然而,犯錯在所難免,保持程式碼符合PEP 8規範的要求仍是一件麻煩事。工具pep8()就是用來解決這個問題的,它能自動檢查Python檔案是否符合PEP 8要求。
    pep8會顯示在哪行哪裡違反了PEP 8,併為每個問題給出其錯誤碼。如果違反了那些必須遵守的規範,則會報出錯誤(以E開頭的錯誤碼),如果是細小的問題則會報警告(以W開頭的錯誤碼)。跟在字母后面的三位數字則指出具體的錯誤或警告,可以從錯誤碼的百位數看出問題的大概類別。例如,以E2開頭的錯誤通常與空格有關,以E3開頭的錯誤則與空行有關,而以W6開頭的警告則表明使用了已廢棄的功能。

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/220205/viewspace-2145090/,如需轉載,請註明出處,否則將追究法律責任。

相關文章