Python代碼編寫規範

標籤：字串   多個   命名   需要   cas   style   def   模組名   添加   

Python代碼編寫規範

編碼:

a)     如無特殊情況,檔案一律使用UTF-8編碼

b)     如無需特殊情況,檔案頭部必須加入#-*-coding:utf-8-*-

縮排

a)     統一使用4個空格進行縮排

引號

a)     自然語言使用雙引號”….”,Regex使用原生的雙引號r””

b)     機器標識使用單引號’’

c)      文檔字串(docstring)使用三個雙引號”””…”””

空行

a)     模組層級函數和類定義之間空兩行

b)     類成員函數之間空一行

import語句

a)     import語句應按照順序排列,每組之間用一個空行分隔

二元運算子

a)     二元運算子兩邊各空一格, = -

函數的參數列表

a)     函數的參數列表中’,’逗號之後要有空格

b)     函數的參數列表中,預設值等號兩邊不要添加空格

c)      左括弧之後,右括弧之前不要加多餘的空格

d)     字典對象的左括弧之前不要多餘的空格

換行

a)     第二行縮排到括弧的起始處

b)     第二行縮排4個空格,適用於起始括弧就換行的情形

docstring

a)     所有的公用模組,函數,類,方法,都應該寫docstring,私人方法不一定需要,但是應該在def後提供一個塊注釋來說明”””…”””

注釋

a)     有意義的注釋 list #list

b)     比較重要的注釋段,使用多個等號隔開,可以更加醒目,突出重要性

命名規範

a)     模組名稱盡量使用小寫命名,首字母保持小寫,盡量不要用底線(除非多個單詞,且數量不多的情況

b)     類名使用駝峰(CamelCase)命名風格,首字母大寫

c)      函數命名一律小寫,如有多個單詞,用底線隔開

d)     變數名盡量小寫,如有多個單詞,用底線隔開

e)     常量採用全大寫,如有多個單詞,使用底線隔開

 

Python代碼編寫規範