代码整洁之道-07
代碼中隨處可見命名,包括變量、函數、參數、類和包以及源碼所在目錄的命名等。好的命名因遵循以下幾條規則。
1、名副其實
選擇體現本意的、易理解的名稱。
2、避免誤導
避免使用縮寫,避免使用小寫字母l和大寫字母O作為變量。
3、做有意義的區分
NameString命名會比Name好嗎?
4、使用讀的出來的名稱
命名一個生成日期、年、月、日、時、分、秒的變量。genymdhms這個好嗎?肯定是不好的。
5、使用可搜索的名稱
單個數字或字母很難在全篇代碼中找到。
6、避免使用編碼
編碼已經很全,無需自己搞一套。
7、去掉成員變量前綴
不必用m_前綴來標明成員變量,應當把類和函數做的足夠小,消除對成員前綴的需要,可以使用編輯器的高亮或顏色功能標出。
8、避免思維映射
避免將名稱讓讀者在腦海中翻譯成他們熟知的名稱。
9、每個概念對應一個詞
同一堆代碼中有controller又有manager,為什么不全用manager或controller。
10、別用雙關語
避免將同意單詞用于不同目的。
11、使用解決方案領域名稱
只有程序員才會讀代碼,所有盡量用計算機科學術語、算法名等。
12、使用源自所涉問題領域的名稱
如果不能用程序員熟悉的術語來命名,就采用所涉及問題領域的術語來命名。
13、添加有意義的語境
很少有名稱能自我說明,我們需要有良好的命名類、函數或名稱空間來放置名稱,給讀者提供語境。
總結
- 上一篇: 代码整洁之道-06
- 下一篇: 什么是schema?