程序員的命名素養

引言

今天來聊聊命名相關內容。

在平常工做中，項目、類、方法、表等等等等，都須要咱們起名來標識區分。好的名字讓人賞心悅目，很差的名字讓人看的想吐。

最近工做有幸寫了node、前端、php、sql、scala，也見識了公司各位前輩們的命名功底。其中不乏abc命名、拼音命名、蹩腳英文命名，更有很多從別的地方粘過來連名都不改的操做。

命名沒有對錯，只是規範一點，能夠提升可讀性、可維護性。

命名原則

拼寫正確

拼寫正確是可讀的基礎。

play shift和play shit本身體會一下

清新明瞭，見名知意

根據要表達的內容命名，一針見血。

getNameById 根據id獲取名稱
ClassLoader 類加載器
MYSQL_USERNAME mysql用戶名

如上幾個例子，咱們一眼就知道要表達什麼，可讀性高。

使用英文字母命名

在編程中，英文仍是較爲主流的，最好使用單詞來命名，再不濟也是用拼音來命名。

不管是拼音或單詞，清晰表意是首要。

保持一致

在一個項目中，應該使用統一的規範來命名。

無規矩不成方圓。

合理使用動詞名詞

類名、變量名一般應使用名詞。如ClassLoader、userId

對於方法名、函數名，應包含動詞。如handleClick、generateUniqueId

命名方法

常見的命名方法有駝峯命名法、匈牙利命名法、帕斯卡命名法、中/下劃線命名法

駝峯命名法Camel-Case

駝峯命名法，又叫小駝峯命名法，如名稱所表達的意思，指混合使用大小寫字母老表示名字。

如userId、getCompanyNameById

應用很普遍。

匈牙利命名法

基本原則是：變量名=屬性+類型+對象描述。經過名稱能夠直觀的瞭解他的所屬、類型等信息。

是早期的命名方式，早期IDE沒有很智能的時候，這種命名是頗有必要的。

如iNum，表示int類型的num

如今依舊不多有人用了。

帕斯卡命名法

又叫大駝峯命名法，就是把駝峯命名的首字母大寫了。

如ClassLoader

中/下劃線命名法

單詞所有小寫，單詞和單詞間用中劃線或下劃線分割。

如user_id、python-flask-demo

下劃線命名在數據庫中較爲常見。

常量命名法

這個不是官方的方法，可是常量通常是由固定規範的。

格式：全部單詞的全部字母都是大寫，單詞之間用下戶線鏈接。

如APOLLO_NAMESPAC

總結

好的命名習慣是每一個程序員必備的基本素養。

寫代碼時，好的命名會讓思路更加清洗，代碼寫的更加絲滑。

代碼就是程序員的形象，從命名的細節開始，讓本身更帥一些。

---

我的公衆號：碼農峯，定時推送行業資訊，持續發佈原創技術文章，歡迎你們關注。