平常寫代碼雜亂無章的,自己看上去沒太大影響,但是當別人來讀你的代碼的時候就苦不堪言,自己再去整理的時候很多問題也難以發現,代碼過程中也是東一塊西一塊像是拼接成似的,所以這個時候規范化的代碼就顯得格外重要,小編在實驗室的練習過程中就發現,與學校合作的公司項目要求都是在項目命名格外注重的。
- 項目名——首字母大寫、其余單詞小寫,多單詞組合則用下劃線分割
- 包名、模塊名——全用小寫字母
- 類名——首字母大寫、其他字母小寫,多單詞采用駝峰
- 方法——小寫單詞
- 函數——若函數的參數名與保留關鍵字沖突,則在參數后加一個下劃線,比拼音好太多
- 全局變量——采用全大寫,多單詞用下劃線分割
注意:
1.不論是類成員變量還是全局變量,均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標識,多定義公開成員,少定義私有成員。
3.變量名不應帶有類型信息,因為Python是動態類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。
4.開頭,結尾,一般為python的自有變量,不要以這種方式命名
5.以__開頭(2個下劃線),是私有實例變量(外部不嫩直接訪問),依照情況進行命名
縮寫
命名應當盡量使用全拼寫的單詞,縮寫的情況有如下兩種:
- 常用的縮寫,如XML、ID等,在命名時也應只大寫首字母,如XmlParser。
- 命名中含有長單詞,對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等。
前導后綴下劃線
一個前導下劃線:表示非公有。
一個后綴下劃線:避免關鍵字沖突。
兩個前導下劃線:當命名一個類屬性引起名稱沖突時使用。
兩個前導和后綴下劃線:(有特殊用圖)的對象或者屬性,例如init或者file。絕對不要創造這樣的名字,而只是使用它們。
注意——關于下劃線的使用存在一些爭議。
命名注意:
不要使用小寫字母'l'(el),大寫字母'O'(oh),或者小寫'i'作為單獨變量名稱。因為一些字體中,上訴字母和數字很難區分(比如:O和0,l和1)。
- 參考自python學習筆記