Python編碼規範之命名規範

2021-06-08 22:07:18 字數 1019 閱讀 3006

1、不要使用小寫字母'l'(el),大寫字母'o'(oh),或者小寫'i'作為單獨變數名稱。因為一些字型中,上訴字母和數字很難區分(比如:o和0,l和1)。

2、module應該採用全小寫,並且盡可能短的命名,可以在模組名中使用下劃線以提高可讀性。package應該採用全部小寫,並且也要盡可能短的命名,但不允許使用下劃線。當乙個用c 或c++ 寫的擴充套件模組,有乙個伴隨的python 模組來提供乙個更高層(例如,更物件導向)的介面時,c/c++模組名有乙個前導下劃線(如:_socket)。

3、類名使用首字母大寫單詞串(capwords) 的約定。 內部使用的類使用乙個額外的前導下劃線。

4、因為異常應該是類,故類命名約定也適用於異常。然而,你應該對異常名新增字尾"error" (如果該異常的確是乙個錯誤)。

5、對設計為通過"from m import " 來使用的模組,應採用all 機制來防止導 出全域性變數;或者使用舊的約定,為該類全域性變數加乙個前導下劃線(可能你想表 明這些全域性變數是"module non-public")。

6、函式名應該為小寫,必要時可用下劃線分隔單詞以增加可讀性。 混合大小寫(mixedcase) 僅被允許用於這種風格已經佔優勢的上下文(如:threading.py),以便保持向後相容。

7、對例項的方法,總是用'self' 做第乙個引數。對類的方法,總是用'cls' 做第乙個引數。如果函式的引數名與保留關鍵字衝突,在引數名後加乙個下劃線,比用縮寫、錯誤 的拼寫要好。因此 "_print" 比 "prnt" 好。(也許使用同義詞來避免衝突更好。) 

8、方法名和例項變數:採用函式命名規則:小寫單詞,必要時可用下劃線分隔單詞以增加可讀性。僅對non-public 方法和例項變數採用乙個前導下劃線。為避免與子類命名衝突,採用兩個前導下劃線來觸發python 的命名重整規則。python用類名重整這些名字:如果類foo 有乙個屬性名為__a, 它不能以foo.__a 訪問。(執著的使用者還是可以通過foo._foo__a.得到訪問權。)通常,雙前導下劃線僅被用來避免與基類的屬性發生名字衝突。

9、常量定義全部為大寫,必要時可用下劃線分隔單詞以增加可讀性。

iOS之命名規範 編碼規範

遵守規範也是讓 更清晰明了,易讀,易用,易維護,可以更好的適應團隊開發。自己看著也是賞心悅目,何樂而不為呢。簡單明瞭的命名最好,不要用單詞的簡寫,盡量用單詞的全稱。可以看看蘋果的api格式,仿照蘋果的命名,盡量用英文,而不是拼音。比如方法名的功能型別的一致性,比如獲取某些資料 nsstring ge...

IOS編碼規範(命名規範)

一.命名規則 命名總則 1.使 用駝峰法命名,命名清晰明了,要做到 自描述,不能省略,部分cocoa通 用縮略詞能夠縮寫。objective c不 支援名字命名空間,所以某些命名要加項 目前綴區別。需要加字首的地 方 全域性變數,類名,全域性函式,category 每個類別,函式都必須新增字首 3....

C 編碼規範 2 命名規範

如果你 中的變數名,函式數,類名都取得很好,不僅是個有意義的詞或短語,而且確切的表達了該變數或函式的功能.那讀起 來就像看文章一樣,絕對是一種享受.當然理想是美好的,現實可是殘酷的.很少有人能做到這樣.一來嘛你英語詞彙量得多,不樣不容易找到那麼多合適並貼切的詞.二來就是有些詞組合就會很長,這樣不得不...