[Python] 髒髒的程式 — 關於變數命名

Young Chen
宅男雜誌
Published in
2 min readJan 31, 2019

Dirty Code

最近工作開始改寫一系列Python程式碼,從頭到尾都我自己設計的程式不多,但改程式碼倒是經驗很多。自從用Python討飯吃之後,一接手就是菸酒生寫的程式碼,很痛苦,真的很痛苦。關於程式碼潔癖我不是很嚴重,但是寫出一個很難讓後人協作的東西我實在很感冒,改寫程式中由於也一邊進行Clean Code研究,就先分享一下命名慣例好了。

Python 命名慣例:

一般變數/模組等等命名習慣底線分隔就好,除了Class/Exception使用首字大寫camel case外。然而,最近接手程式碼太有創意,為什麼變數、函數、資料庫欄位也通通camel case,我真的崩潰。

看烙賽程式碼的感覺

此外,變數命名還有一個重要的要點 — 要有意義。最近看到接手程式中一個命名,吐槽一下:

Datadf = pd.read_json(f, orient='split')

首先變數命名慣例不符就算了,重點是超級冗。pandas裡面dataframe常縮寫成df當作變數了,為他加點描述說是「什麼」dataframe是有助於閱讀的。但是再加個Data字眼到底是…?我是會觀落陰知道你在表示啥資料膩?不知道我這專案做完,到底有多少槽可以吐。

--

--

Young Chen
宅男雜誌

曾經是全端工程師,目前在資料科學團隊中主要負責雲端架構相關工作,透過自學正在資料科學領域相關知識耕耘中。mail: chiyoung0307@gmail.com