1. 程式人生 > >Python如何更好的使用變數名

Python如何更好的使用變數名

變數用的好與不好,和程式碼的質量有著非常重要的聯絡。

如何為變數起名

  • 在程式設計中起的最多的名字,還數各種的變數。給變數起一個好的名字很重要,因為好的變數命名可以極大的提高程式碼整體的可讀性
1.變數名具有描述性
  • 比如:
    • 正確的變數名:start_time
    • 錯誤的變數名:time
2.變數名最好能簡單易懂,一下就能猜出型別
  • 布林型別變數最大特點:只存在不是。所以用 ishas 詞修飾變數名。原則就是讓讀到變數名的人馬上就能判斷出這個變數只會有不是 兩種
    • 比如:
      • 是否刪除: is_delete
      • 是否禁用 : is_enabled
      • 有沒有錯誤 : has_error
  • 人們看到和數字相關的名字,都會預設他們是int/float 型別。
    • 比如:
      • 釋義為數字的單詞:port(埠) 或者 price(價格)
      • 使用_id結尾的單詞: user_id 或者 object_Id
      • 使用length/count開頭結尾的單詞: max_length 或者 mix_count
  • 其他型別 str、list、tuple、dict 這些複雜的型別,很難有統一規則讓我們去猜變數型別。對於這些變數名,最推薦的方式,就是編寫規範
    文件。
3.使用匈牙利命名法
  • 簡而言之,匈牙利命名法就是把變數的型別縮寫,放到變數名的最前面。
  • 這裡的型別並不是指的資料型別,而是在程式碼裡面的業務邏輯型別。
    • 比如:
      • 在程式碼中有兩個變數:students、teachers ,他們指向的內容都是Person物件的list。使用匈牙利後,可以把這兩個名字改寫成這樣:
        • students -> pl_students(p代表的是person、l代表的是list)
        • teachers -> pl_teachers(跟學生同理)
4.變數名儘量短,但是不要太過於短
  • 如果說不限制變數名的長度,可能你會寫出極強的變數名:
    • 比如:
      • answer_much_question_for_table
      • 可以看出來這個變數名相當於一個函式名一樣,在程式碼裡呼叫的時候,也會產生很大的誤解。所以answer_much_question_for_table。強烈不推薦。
      • 一個好的變數名長度控制在兩到三個單詞左右
5.其他注意事項
  • 同一段程式碼內不要使用過於相似變數名
    • 比如:
      • useruser1user2等等。
  • 不要使用帶否定含義的變數名
    • 比如:
      • is_delete 替換 is_not_delete
  • 不要使用python 裡面的關鍵字 或者是函式名、物件名作為變數名,並且變數名可以是大小寫的字母或_(下劃線),不能是數字開頭