- 相關(guān)推薦
關(guān)于Java源代碼折行的規則
一些企業(yè)在招聘程序員的時(shí)候，總會(huì )特意提出一個(gè)要求，即“要求具有良好的編碼規范”。下面小編準備了關(guān)于Java源代碼折行的規則，提供給大家參考!
一、代碼的最大長(cháng)度。
雖然在Java的編譯器中對于代碼的最大長(cháng)度沒(méi)有硬性的規定。但是如果代碼的長(cháng)度太長(cháng)，超過(guò)了編譯器的最當行寬，顯然閱讀起來(lái)比較麻煩。為此根據筆者的經(jīng)驗，通常情況下Java源代碼的行長(cháng)度不應該大于80個(gè)字符。如果超過(guò)這個(gè)長(cháng)度的話(huà)，在一些開(kāi)發(fā)工具和編輯器上就無(wú)法很好的顯示。如需要通過(guò)滾動(dòng)條來(lái)顯示后面部分的代碼。當其他項目成員閱讀這超長(cháng)的代碼時(shí)，就會(huì )看得眼花繚亂。當人的溫飽問(wèn)題解決了之后，就需要開(kāi)始注意美觀(guān)方面的問(wèn)題。所以程序開(kāi)發(fā)人員在開(kāi)發(fā)應用程序的時(shí)候，要盡量避免書(shū)寫(xiě)長(cháng)的代碼。如果代碼的每行長(cháng)度確實(shí)需要超過(guò)80個(gè)字符的話(huà)(最好將每行代碼的長(cháng)度控制在70個(gè)字符左右)，那么就需要對代碼進(jìn)行分行。
二、在恰當的地方對代碼進(jìn)行分行。
建議將Java源代碼每行的長(cháng)度控制在70個(gè)字符、最大不超過(guò)80個(gè)字符。當超過(guò)這個(gè)字符長(cháng)度的時(shí)候，開(kāi)發(fā)人員就需要考慮在恰當的地方對他們進(jìn)行分行處理。不過(guò)這個(gè)分行也不是說(shuō)開(kāi)發(fā)人員想在哪里進(jìn)行分行就在哪里進(jìn)行分行。這個(gè)分行是有一定技巧的。雖然這些技巧大部分并不是強制性的規定，但是都是一些專(zhuān)家們的經(jīng)驗總結，可以提高代碼的閱讀性。為此筆者希望各位程序開(kāi)發(fā)能夠嚴格的遵守。
技巧一：高層折行優(yōu)于低層折行。
這個(gè)技巧是說(shuō)，在考慮對代碼進(jìn)行折行處理的時(shí)候，需要注意代碼的層次性。如某段代碼涉及到混合四則運算，而四則運算又有明顯的運算順序，此時(shí)對代碼進(jìn)行折行時(shí)就最好能夠在四則運算的關(guān)鍵順序上進(jìn)行折行處理。如現在有如下的一段代碼：
Mynum=mynum1*(mynum1+mynue2+mynum3-mynum4)+8*mynum5
如果要對這段代碼進(jìn)行折行的話(huà)，該在哪個(gè)地方加入一個(gè)折行符號呢?如果是筆者處理的話(huà)，筆者會(huì )按如下的格式對代碼進(jìn)行折行處理。
Mynum=mynum1*(mynum1+mynue2+mynum3-mynum4)
+8*mynum5
這主要是根據四則運算的運算層次來(lái)進(jìn)行折行的。顯然，*符號的優(yōu)先級要比+符號要高。所以在+號前面對其進(jìn)行折行處理，那么就可以一目了然的反應出代碼的運算層次�？梢源蠓鹊奶岣叽a的閱讀性。所以代碼折行的第一個(gè)技巧就是高層折行優(yōu)于低層折行。如此的話(huà)，可以使得應用程序的結構代碼更加的清晰，更容易被團隊成員所理解。
技巧二：在運算符前面進(jìn)行折行處理。
其實(shí)在如上的折行技巧中，還隱藏著(zhù)一個(gè)規則，即在運算符之前進(jìn)行折行。如上例所示，筆者就是在+號前面進(jìn)行折行，而不是在+號后面進(jìn)行折行處理。這主要也是考慮到代碼的可讀性。如上面這個(gè)例子中，如果在+號后面進(jìn)行折行處理的話(huà)，則下一行就會(huì )給人一種憑空多出來(lái)的感覺(jué)，顯得代碼很不連貫。跟這個(gè)規則類(lèi)似，如果在折行處理的時(shí)候遇到逗號時(shí)，那么最好能夠在逗號后面進(jìn)行折行。如在一個(gè)方法中，需要傳入5個(gè)參數。此時(shí)如果代碼行比較長(cháng)，那么就需要在幾個(gè)參數之間進(jìn)行折行處理。此時(shí)最理想的折行位置，就是在某個(gè)參數的逗號后面。注意，使在逗號后面進(jìn)行折行，而不是在逗號前面。因為一個(gè)參數一個(gè)逗號是匹對的。而如果一個(gè)逗號加一個(gè)參數，則讓人看起來(lái)很不舒服。
技巧三：這行代碼的對起方式。
當不得已對代碼進(jìn)行折行處理時(shí)，下一行的代碼應該與其同等級的代碼行左對齊。如上例所示，在+號前面將某一段四則運算公式進(jìn)行折行處理的時(shí)候，其+號符號已經(jīng)采取縮進(jìn)處理。其縮進(jìn)后的效果就是要與其同等級的代碼行左對齊。如此的話(huà)，明眼人一看就知道這段代碼采取過(guò)折行處理;而且跟上一行代碼的層次關(guān)系。當一段代碼被分割成三行甚至跟更多行數的時(shí)候，這個(gè)規則會(huì )非常的有用。如果能夠嚴格遵守這個(gè)規則，即使將代碼分割成多行，看起來(lái)也不會(huì )覺(jué)得那么混亂。反而給人一種比較有層次的感覺(jué)。
另外在采取縮進(jìn)處理的時(shí)候，可以利用Tab鍵來(lái)提高縮進(jìn)處理的效率。因為直接按空格的話(huà)，有可能空格字符數量不一致，會(huì )讓人覺(jué)得層次不起，產(chǎn)生比較大的混亂。一般情況下，當代碼行兩側距離頁(yè)邊的距離比較大，看其來(lái)不怎么舒服時(shí)，可以在代碼行中通過(guò)插入TAB鍵(會(huì )在代碼行中連續插入8個(gè)字符)來(lái)提高代碼的閱讀性，讓代碼的縮進(jìn)實(shí)現統一。
技巧四：為變量尋找一個(gè)合適的位置。
在編寫(xiě)應用程序時(shí)，盡量將變量聲明放置在一個(gè)代碼塊的開(kāi)始處，也就是說(shuō){}花括號的開(kāi)始位置。雖然說(shuō)可以在需要使用變量的時(shí)候再對其進(jìn)行聲明。但是筆者不同義如此操作。因為如果在的呢感到使用變量的時(shí)候再來(lái)聲明變量時(shí)，會(huì )降低代碼的可讀性。同理，也需要避免低層聲明與高層聲明重復，這樣會(huì )引起代碼混亂并可能引發(fā)程序功能性錯誤。而且這種錯誤在后續的排錯中很難被發(fā)現。為此要在應用程序開(kāi)發(fā)的時(shí)候就要盡量避免這種錯誤。
在聲明變量的時(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í)候往往需要對變量加一個(gè)注釋說(shuō)明變量的用途，如果以行定義一個(gè)變量，添加行注釋也相對簡(jiǎn)單許多。
總之，以上的這些折行的規則基本上不會(huì )影響到代碼的運行。但是，對于代碼的維護與后續的排錯、升級、二次開(kāi)發(fā)等等具有不可忽視的作用。而且現在基本上應用程序開(kāi)發(fā)式團隊開(kāi)發(fā)，故大家都遵守同樣的代碼編寫(xiě)規范是非常重要的。
【Java源代碼折行的規則】相關(guān)文章：
java非對稱(chēng)加密的源代碼(rsa)03-30
象棋的行棋規則03-22
圍棋行棋規則與勝負計算規則03-20
圍棋行棋規則講解06-16
圍棋入門(mén)知識：行棋規則03-19
國際象棋行棋規則03-20