Python中的編碼風格
阿新 • • 發佈:2021-06-22
詳細內容參照:https://www.python.org/dev/peps/pep-0008/
要點提取:
1、使用 4 個空格縮排,嚴禁Tab和空格兩者混用,如果使用 tab 縮排,設定tab 為 4 個空格。
2、4 個空格是小縮排(允許更大的巢狀深度)和大縮排(更容易閱讀)之間的一個很好的折衷。Tab會引起混亂,最好不要使用。
3、換行,使其不超過 79 個字元,這有助於使用小顯示器的使用者,並可以在較大的顯示器上並排放置多個程式碼檔案。
4、使用空行來分隔函式和類,以及函式內部的較大程式碼塊。
5、如果可能的話,將註釋寫在一行中。
6、使用文件字串,文件字串使用慣例:它的首行簡述函式功能,第二行空行,第三行為函式的具體描述。如:
def printMax(x,y): '''列印兩個數中的最大值。 兩個值必須都是在整形數。''' x=int(x) y=int(y) if x>y: print(x,'最大') else: print(y,'最大') printMax(3,5) print (printMax.__doc__) # 呼叫 doc
7、在運算子周圍和逗號後使用空格,但不要直接在括號結構內使用:.a=f(1,2)+g(3,4)
注意點:
在二元算術、邏輯運算子前後加空格:如:a = b + c;
在一元字首運算子後不加空格,如:if !flg: pass;
“:”用在行尾時前後皆不加空格,如分枝、迴圈、函式和類定義語言;用在非行尾時兩端加空格,如:
dict 物件的定義:d = {'key' : 'value'} 括號(含圓括號、方括號和花括號)前後不加空格,如:do_something(arg1, arg2),而不是:do_something( arg1, arg2 ) 不要在逗號、分號、冒號前面加空格,但應該在它們後面加(除了在行尾)
不要用空格來垂直對齊多行間的標記,因為這會成為維護的負擔(適用於:,#,=等)
8、一致地命名您的類和函式,約定的是:
類:單詞首字母總是大寫,私有類可以下劃線開頭。如:UpperCamelCase。 函式:函式名一律小寫,若有多個單詞用下劃線隔開。如:lowercase_with_underscores。另外,私有函式下劃線開頭 。如:_lowercase_with_underscores
9、如果您的程式碼打算在國際環境中使用,請不要使用花哨的編碼。在任何情況下,Python 的預設值、UTF-8 甚至純 ASCII 都效果最好。
同樣,如果使用不同語言的人閱讀或維護程式碼的可能性很小,則不要在識別符號中使用非 ASCII 字元。