編寫干凈哩罪、可理解和可維護(hù)的代碼是每個開發(fā)人員必須掌握的關(guān)鍵技能。
在這篇文章中,我們將著眼于提高代碼質(zhì)量的最重要的原則片排,并為您提供每個原則的代碼示例。
大多數(shù)例子都取自Robert J. Martin的《Clean Code》速侈。這是一本編程經(jīng)典率寡,如果有時間,建議閱讀全文锌畸。
1. 創(chuàng)建有意義的變量名
不要使用注釋去解釋一個變量名的定義勇劣,如果一個變量需要用注釋,我們應(yīng)該考慮如何重命名潭枣,使我們的變量更表意比默。
"A name should tell you why it exists, what it does, and how it is used. If a name requires a comment, then the name does not reveal its intent." ? ? ? ? ? ? ? ? – Clean Code
Bad example:
var d; // elapsed time in days
Good example:
var elapsedTimeInDays;
var daysSinceCreation;
var daysSinceModification;
2.?避免歧義
小心那些有特定含義的詞。例如不要將帳戶分組命名為accountList盆犁,除非它的type確實是List命咐。這個詞有特定的含義,它可能會導(dǎo)致錯誤的結(jié)論谐岁。
即使type是list醋奠,比起accountList, accounts是一個更好的選擇
3. 避免無意義的單詞(噪聲詞)
噪聲詞是指不提供關(guān)于變量的任何附加信息的詞。它們是多余的伊佃,應(yīng)該刪除窜司。
一些使用頻繁的噪聲詞:
- The (prefix)
- Info
- Data
- Variable
- Object
-?Manager
如果你定義的變量名是userInfo,你可以直接修改為user; 如果你定義的方法名是getOrderData航揉,你可以直接命名為getOrder塞祈。去掉這些噪聲詞,依然不影響我們根據(jù)變量名來理解所定義的變量的意義帅涂,而且我們的變量名也變得更加簡潔议薪。