選擇簡單易懂的名稱
除非編寫的程式碼是“一次性”的,僅需執行一次,不需要長期維護,否則應該在命名這件事上花些工夫。如果只是簡單地用a,b,c作為變數名,將會花費不必要的心裡會議當初這些變數的作用。
計算機並不在乎名稱是否言簡意賅還是語焉不詳。名稱的作用是讓人更容易閱讀而不是讓計算機更容易執行。
注意事項
- 不要覆蓋內建名稱
- 識別符號區分大小寫,且不能包含空格。
- 資料型別的字首,需要刪除
- 不要帶有連續數字字尾的名稱
- 如果是在大專案中,查詢功能會經常使用,所以請包含具體細節的較長且特殊的名稱
- 避免笑話、雙關語和需要文化背景才能理解的詞彙
命名風格
- 蛇形命名法
(snake_case)用下劃線分割單詞,兩個單詞之間的連線看起來像是蛇一樣。這種情況下,所有字母都是小寫,但常量名經常採用大寫,類似於 UPPER_SNAKE_CASE
- 駝峰命名法
(camelCase)從第二個單詞開始,每個單詞使用首寫字母大寫進行分隔,也就是第一個單詞手寫字母小寫,後面的單詞的大寫字幕看起來像駝峰。
- Pascal命名法
(PascalCase)因其在Pascal程式語言中的使用而得名。它跟駝峰命名法類似,但第一個單詞的首字母也要大寫。
適當的名稱長度
-
名稱太短
1. 只有一個或兩個字母的名稱對程式碼的人而言很省事,但對別人而言很難讀懂。
2. 縮寫名稱比如mon,可以用來代表監視器、月份、怪物等單詞
3. 單個詞語,像是start,不明白是什麼的開始。
-
名稱太長
1. 呈現過多的細節,描述性過強的名稱
PEP8的命名風格
- 所有的字母應是ASCII字母,也就是沒有重音符號的大寫和小寫的英文字母
- 模組名應該簡短,都是小寫字母
- 類名應使用Pascal命名法
- 常量名應使用大寫字母的蛇形命名法
- 函式名、方法名和變數名應使用小寫字母的蛇形命名法
- 方法的第一個引數,應總是命名為小寫的self
- 類方法的第一個引數應總是命名為小寫的cls
- 類中的私有屬性應總是以下劃線(_)開頭
- 類中的公共屬性不應以下劃線開頭
重複程式碼
透過把程式碼放在一個函式或者迴圈中,使其在程式碼中只出現一次。