在程序員的招聘信息中,我們通??梢钥吹竭@樣一個(gè)要求,即具有良好的編碼規(guī)范。事實(shí)確實(shí)如此,在程序開(kāi)發(fā)人員團(tuán)體作戰(zhàn)的趨勢(shì)下,團(tuán)隊(duì)內(nèi)的成員恪守代碼的編寫(xiě)規(guī)范,對(duì)于共享代碼、排錯(cuò)等作業(yè)都具有非?,F(xiàn)實(shí)的意義。這在Java語(yǔ)言中當(dāng)然也不例外。筆者借這次機(jī)會(huì),就跟大家分享一下Java源代碼的折行規(guī)則。這對(duì)提高代碼的閱讀性有著至關(guān)重要的作用。
一、代碼的最大長(zhǎng)度。
雖然在Java的編譯器中對(duì)于代碼的最大長(zhǎng)度沒(méi)有強(qiáng)制性的規(guī)定。但是如果代碼的長(zhǎng)度太長(zhǎng),超過(guò)了編譯器的最當(dāng)行寬,顯然閱讀起來(lái)比較麻煩。通常情況下Java源代碼的行長(zhǎng)度不應(yīng)該大于80個(gè)字符。如果超過(guò)這個(gè)長(zhǎng)度的話,在一些開(kāi)發(fā)工具和編輯器上就無(wú)法很好的顯示。如需要通過(guò)滾動(dòng)條來(lái)顯示后面部分的代碼。當(dāng)其他項(xiàng)目成員閱讀這超長(zhǎng)的代碼時(shí),就會(huì)看得眼花繚亂。所以程序開(kāi)發(fā)人員在開(kāi)發(fā)應(yīng)用程序的時(shí)候,要盡量避免書(shū)寫(xiě)長(zhǎng)的代碼。這是影響到美觀的問(wèn)題。如果代碼的每行長(zhǎng)度確實(shí)需要超過(guò)80個(gè)字符的話(最好將每行代碼的長(zhǎng)度控制在70個(gè)字符左右),那么就需要對(duì)代碼進(jìn)行分行。
二、在恰當(dāng)?shù)牡胤綄?duì)代碼進(jìn)行分行。
筆者建議將Java源代碼每行的長(zhǎng)度控制在70個(gè)字符、最大不超過(guò)80個(gè)字符。當(dāng)超過(guò)這個(gè)字符長(zhǎng)度的時(shí)候,開(kāi)發(fā)人員就需要考慮在恰當(dāng)?shù)牡胤綄?duì)他們進(jìn)行分行處理。不過(guò)這個(gè)分行也不是說(shuō)開(kāi)發(fā)人員想在哪里進(jìn)行分行就在哪里進(jìn)行分行。這個(gè)分行是有一定技巧的。雖然這些技巧大部分并不是硬性的規(guī)定,但是都是一些專(zhuān)家們的經(jīng)驗(yàn)總結(jié),可以提高代碼的閱讀性。
技巧一:高層折行優(yōu)于低層折行。
這個(gè)技巧是說(shuō),在考慮對(duì)代碼進(jìn)行折行處理的時(shí)候,需要注意代碼的層次性。如某段代碼涉及到混合四則運(yùn)算,而四則運(yùn)算又有明顯的運(yùn)算順序,此時(shí)對(duì)代碼進(jìn)行折行時(shí)就最好能夠在四則運(yùn)算的關(guān)鍵順序上進(jìn)行折行處理。如現(xiàn)在有如下的一段代碼:
Mynum=mynum1*(mynum1+mynue2+mynum3-mynum4)+8*mynum5
如果要對(duì)這段代碼進(jìn)行折行的話,該在哪個(gè)地方加入一個(gè)折行符號(hào)呢?如果是筆者處理的話,筆者會(huì)按如下的格式對(duì)代碼進(jìn)行折行處理。
Mynum=mynum1*(mynum1+mynue2+mynum3-mynum4)
+8*mynum5
這主要是根據(jù)四則運(yùn)算的運(yùn)算層次來(lái)進(jìn)行折行的。顯然,*符號(hào)的優(yōu)先級(jí)要比+符號(hào)要高。所以在+號(hào)前面對(duì)其進(jìn)行折行處理,那么就可以一目了然的反應(yīng)出代碼的運(yùn)算層次??梢源蠓鹊奶岣叽a的閱讀性。所以代碼折行的第一個(gè)技巧就是高層折行優(yōu)于低層折行。如此的話,可以使得應(yīng)用程序的結(jié)構(gòu)代碼更加的清晰,更容易被團(tuán)隊(duì)成員所理解。
技巧二:為變量尋找一個(gè)合適的位置。
在編寫(xiě)應(yīng)用程序時(shí),盡量將變量聲明放置在一個(gè)代碼塊的開(kāi)始處,也就是說(shuō){}花括號(hào)的開(kāi)始位置。雖然說(shuō)可以在需要使用變量的時(shí)候再對(duì)其進(jìn)行聲明。但是筆者不同義如此操作。因?yàn)槿绻诘哪馗械绞褂米兞康臅r(shí)候再來(lái)聲明變量時(shí),會(huì)降低代碼的可讀性。同理,也需要避免低層聲明與高層聲明重復(fù),這樣會(huì)引起代碼混亂并可能引發(fā)程序功能性錯(cuò)誤。而且這種錯(cuò)誤在后續(xù)的排錯(cuò)中很難被發(fā)現(xiàn)。為此要在應(yīng)用程序開(kāi)發(fā)的時(shí)候就要盡量避免這種錯(cuò)誤。
在聲明變量的時(shí)候,有時(shí)候可能代碼很簡(jiǎn)單,生命變量的行總共加起來(lái)也不會(huì)超過(guò)十個(gè)字符。此時(shí)能否把多個(gè)變量的聲明寫(xiě)在同一行呢?從就技術(shù)上來(lái)說(shuō),這是可行的。也就是說(shuō),Java編譯器允許將多個(gè)變量定義在同一行上。但是從閱讀性上來(lái)說(shuō),這并不是很好的做法。筆者的建議是,即使變量定義再簡(jiǎn)單,或者變量比較多,也最好分行進(jìn)行變量的聲明。也就是說(shuō),一行聲明一個(gè)變量。這可以提高代碼的可閱讀性。而且有時(shí)候往往需要對(duì)變量加一個(gè)注釋說(shuō)明變量的用途,如果以行定義一個(gè)變量,添加行注釋也相對(duì)簡(jiǎn)單許多。
技巧三:在運(yùn)算符前面進(jìn)行折行處理。
其實(shí)在如上的折行技巧中,還隱藏著一個(gè)規(guī)則,即在運(yùn)算符之前進(jìn)行折行。如上例所示,筆者就是在+號(hào)前面進(jìn)行折行,而不是在+號(hào)后面進(jìn)行折行處理。這主要也是考慮到代碼的可讀性。如上面這個(gè)例子中,如果在+號(hào)后面進(jìn)行折行處理的話,則下一行就會(huì)給人一種憑空多出來(lái)的感覺(jué),顯得代碼很不連貫。跟這個(gè)規(guī)則類(lèi)似,如果在折行處理的時(shí)候遇到逗號(hào)時(shí),那么最好能夠在逗號(hào)后面進(jìn)行折行。如在一個(gè)方法中,需要傳入5個(gè)參數(shù)。此時(shí)如果代碼行比較長(zhǎng),那么就需要在幾個(gè)參數(shù)之間進(jìn)行折行處理。此時(shí)最理想的折行位置,就是在某個(gè)參數(shù)的逗號(hào)后面。注意,使在逗號(hào)后面進(jìn)行折行,而不是在逗號(hào)前面。因?yàn)橐粋€(gè)參數(shù)一個(gè)逗號(hào)是匹對(duì)的。而如果一個(gè)逗號(hào)加一個(gè)參數(shù),則讓人看起來(lái)很不舒服。
技巧四:折行代碼的對(duì)齊方式
當(dāng)不得已對(duì)代碼進(jìn)行折行處理時(shí),下一行的代碼應(yīng)該與其同等級(jí)的代碼行左對(duì)齊。如上例所示,在+號(hào)前面將某一段四則運(yùn)算公式進(jìn)行折行處理的時(shí)候,其+號(hào)符號(hào)已經(jīng)采取縮進(jìn)處理。其縮進(jìn)后的效果就是要與其同等級(jí)的代碼行左對(duì)齊。如此的話,明眼人一看就知道這段代碼采取過(guò)折行處理;而且跟上一行代碼的層次關(guān)系。當(dāng)一段代碼被分割成三行甚至跟更多行數(shù)的時(shí)候,這個(gè)規(guī)則會(huì)非常的有用。如果能夠嚴(yán)格遵守這個(gè)規(guī)則,即使將代碼分割成多行,看起來(lái)也不會(huì)覺(jué)得那么混亂。反而給人一種比較有層次的感覺(jué)。
另外在采取縮進(jìn)處理的時(shí)