命名難，難於上青天

（很久沒發文了）

Quora 問答社區的一個開發者投票統計，程序員最大的難題是：如何命名（例如：給變量，類，函數等等），光是如何命名一項的選票幾乎是其它八項的投票結果的總和。如何給變量命名，如何讓它變得有意義成了程序員不可逾越的難題，這篇文章參考了 Clean Code ，提供7條命名建議，但願能在取名字的過程當中給你帶來一些幫助。

如下都是基於Python3.7語法

變量

一、使用有意義並且可讀的變量名

差

ymdstr = datetime.date.today().strftime("%y-%m-%d")
複製代碼

鬼知道 ymd 是什麼？

好

current_date: str = datetime.date.today().strftime("%y-%m-%d")
複製代碼

看到 current_date，一眼就懂。

二、同類型的變量使用相同的詞彙

差：這三個函數都是和用戶相關的信息，卻使用了三個名字

get_user_info()
get_client_data()
get_customer_record()
複製代碼

好： 若是實體相同，你應該統一名字

get_user_info()
get_user_data()
get_user_record()
複製代碼

極好：由於 Python 是一門面向對象的語言，用一個類來實現更加合理，分別用實例屬性、property 方法和實例方法來表示。

class User:
    info : str

 @property
    def data(self) -> dict:
        # ...

    def get_record(self) -> Union[Record, None]:
        # ...
複製代碼

三、使用可搜索的名字

大部分時間你都是在讀代碼而不是寫代碼，因此咱們寫的代碼可讀且可被搜索尤其重要，一個沒有名字的變量沒法幫助咱們理解程序，也傷害了讀者，記住：確保可搜索。

差

time.sleep(86400);
複製代碼

What the fuck， 上帝也不知道86400是個什麼概念

好

# 在全局命名空間聲明變量，一天有多少秒
SECONDS_IN_A_DAY = 60 * 60 * 24

time.sleep(SECONDS_IN_A_DAY)
複製代碼

清晰多了。

四、使用可自我描述的變量

差

address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
matches = re.match(city_zip_code_regex, address)

save_city_zip_code(matches[1], matches[2])
複製代碼

matches[1] 沒有自我解釋本身是誰的做用

通常

address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
matches = re.match(city_zip_code_regex, address)

city, zip_code = matches.groups()
save_city_zip_code(city, zip_code)
複製代碼

你應該看懂了， matches.groups() 自動解包成兩個變量，分別是 city，zip_code

好

address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(?P<city>.+?)\s*(?P<zip_code>\d{5})?$'
matches = re.match(city_zip_code_regex, address)

save_city_zip_code(matches['city'], matches['zip_code'])
複製代碼

五、 不要強迫讀者猜想變量的意義，明瞭勝於晦澀

差

seq = ('Austin', 'New York', 'San Francisco')

for item in seq:
    do_stuff()
    do_some_other_stuff()
    # ...
    # Wait, what's `item` for again?
    dispatch(item)
複製代碼

seq 是什麼？序列？什麼序列呢？沒人知道，只能繼續往下看才知道。

好

locations = ('Austin', 'New York', 'San Francisco')

for location in locations:
    do_stuff()
    do_some_other_stuff()
    # ...
    dispatch(location)
複製代碼

用 locations 表示，一看就知道這是幾個地區組成的元組

六、不要添加無謂的上下文

若是你的類名已經能夠告訴了你什麼，就不要在重複對變量名進行描述

差

class Car:
    car_make: str
    car_model: str
    car_color: str
複製代碼

感受多此一舉，如無必要，勿增實體。

好

class Car:
    make: str
    model: str
    color: str
複製代碼

七、使用默認參數代替短路運算和條件運算

差：

def create_micro_brewery(name):
    name = "Hipster Brew Co." if name is None else name
    slug = hashlib.sha1(name.encode()).hexdigest()
    # etc.
複製代碼

好

def create_micro_brewery(name: str = "Hipster Brew Co."):
    slug = hashlib.sha1(name.encode()).hexdigest()
    # etc.
複製代碼

這個應該能理解吧，既然函數裏面須要對沒有參數的變量作處理，爲啥不在定義的時候指定它呢？