如何編寫易于理解和使用的程序代碼
讓代碼簡短一個(gè)好的程序代碼一定要是清晰易懂的。程序只寫一次,但以后會(huì)有無數(shù)次的閱讀,因此,編寫出好用的程序代碼是很重要的。其中一個(gè)關(guān)鍵點(diǎn)就是讓代碼簡短。不要小看這一點(diǎn),很多人都忽視它,這是不對的。你寫
讓代碼簡短
一個(gè)好的程序代碼一定要是清晰易懂的。程序只寫一次,但以后會(huì)有無數(shù)次的閱讀,因此,編寫出好用的程序代碼是很重要的。其中一個(gè)關(guān)鍵點(diǎn)就是讓代碼簡短。
不要小看這一點(diǎn),很多人都忽視它,這是不對的。你寫的方法要始終能在一個(gè)屏幕里放得下,如果你需要去滾動(dòng)屏幕,這會(huì)分散你的注意力,而且你看不到整個(gè)的上下文。最佳長度是5-20行,這根據(jù)你的情況而定。
避免使用神秘?cái)?shù)字
當(dāng)你要把什么東西跟一個(gè)常量值做比較時(shí),記得把這個(gè)值定義成常量。沒有什么會(huì)比去猜測你的同事寫的這樣的代碼更讓人頭疼的事了。例如,將`il lt; 4384`換成`inputLength lt; MAX_INPUT_LENGTH`會(huì)更加清晰易懂。
使用自描述的變量名和方法名
設(shè)計(jì)出來的代碼要做到:無論是誰,只要看一眼就能知道是干嘛的。盡量不要用簡寫方式,除非有特殊的習(xí)慣。例如,`src - source`, `pos - position`, `prev - previous`這樣的簡寫方式相比于`numTeamMembers, seatCount, numSeatsInStadium`更難理解。
如果你認(rèn)為描述性的名稱并不是那么有價(jià)值,請對比一下`n, ns, nsisd`和`numTeamMembers, seatCount, numSeatsInStadium`。
遵循語言習(xí)俗約定
每種語言都有自己不同的習(xí)俗約定。一般來說,人們聽的最多的是Java的編碼規(guī)范。
讓我們看看其中的一些習(xí)俗規(guī)范:
- 方法名應(yīng)該小寫字母開頭,其后用字母大寫的單詞連接(例如`veryLongVariableName`);
- 類名應(yīng)該都使用首字母大寫的單詞連接而成;
- 常量名應(yīng)該全部大寫,用下劃線連接(例如`MY_CONSTANT`);
- 左大括號應(yīng)該跟if語句在同一行。
只有在有必要的理由時(shí)才去打破這些常規(guī),不要輕易的因?yàn)槟悴桓吲d就違反它。如果你只是在團(tuán)隊(duì)里改變一些這樣的習(xí)慣,那也沒問題,但當(dāng)把你代碼拿出來和其他的沒有這些思想準(zhǔn)備的程序員共享時(shí),問題就會(huì)來了。