請(qǐng)停止寫(xiě)“爛”代碼！
譯文【51CTO.com快譯】作為一名在校教師，我的工作就是不斷審查學(xué)生們編寫(xiě)的代碼。
這里我不想取笑任何人，因此所有實(shí)例皆以匿名形式公布，單純希望大家能夠從中獲得啟示。閑言少敘，咱們先來(lái)看一個(gè)奇妙的例子：
if(a<8&&b<8&&c<8)
a = 8;b=8;c=8;
大家不妨看看其中的錯(cuò)誤在哪。
怎么樣，大家發(fā)現(xiàn)了多少問(wèn)題？
我們先對(duì)其進(jìn)行分析。最惹眼的肯定是“if”的密度。其中的三項(xiàng)條件之間沒(méi)有用空格隔開(kāi)。由于&運(yùn)算符跟8相鄰，因此很容易讓人看花眼。這就是問(wèn)題之一，空格。大家***在代碼內(nèi)容間加上空格，包括各語(yǔ)句之間、運(yùn)算符之前與之后。下面我們對(duì)其進(jìn)行重寫(xiě)：
if(a < 8 && b < 8 && c < 8)
很明顯，現(xiàn)在看起來(lái)好多了。
問(wèn)題二
有過(guò)編程經(jīng)驗(yàn)的朋友對(duì)“魔數(shù)”肯定有著深刻印象。魔數(shù)是指那些直接出現(xiàn)在代碼當(dāng)中，不會(huì)自我描述且對(duì)于閱讀者而言毫無(wú)意義的數(shù)字。如果大家對(duì)于“8”這個(gè)數(shù)字沒(méi)有什么特別的負(fù)面感覺(jué)，那可以肯定您的編程從業(yè)時(shí)間并不長(zhǎng)。這里歡迎大家來(lái)猜猜這個(gè)數(shù)字的含義。由于正是我本人給學(xué)生們布置的作業(yè)，所以我很清楚這里“8”的意義（代表的是工人下班的最早時(shí)間），但對(duì)他人來(lái)說(shuō)則很難猜。更糟糕的是，數(shù)字“8”在這段代碼中重復(fù)編寫(xiě)了6次，意味著如果我們要將其換成7，則需要多次修改并反復(fù)查看以確認(rèn)沒(méi)有漏掉某個(gè)“8”。
解決方案當(dāng)然是使用常量。這里我們可以定義一條常量：
finalint EARLIEST_HOUR = 8;
現(xiàn)在代碼變成了這樣：
if(a < EARLIEST_HOUR && b < EARLIEST_HOUR && c < EARLIEST_HOUR)
a = EARLIEST_HOUR; b = EARLIEST_HOUR; c = EARLIEST_HOUR;
接下來(lái)看看代碼中的語(yǔ)義：這段代碼到底要實(shí)現(xiàn)什么效果？現(xiàn)在有了常數(shù)，看起來(lái)應(yīng)該更為清楚。“if”負(fù)責(zé)測(cè)試三個(gè)變量，a、b與c。如果三個(gè)變量的值全面小于8，則全部獲得最早時(shí)間值分配。這類(lèi)測(cè)試非常常見(jiàn)且能夠防止非法輸入狀況。然而，讓我們?cè)賮?lái)看看if本體——如果條件為真，哪行代碼會(huì)執(zhí)行if結(jié)果？
在開(kāi)始之前，我們首先要強(qiáng)調(diào)一點(diǎn)，Java是會(huì)直接忽略空格的。這意味著就編譯器而言，我們可以隨意使用空格但并非強(qiáng)制性（當(dāng)然，我們必須至少在兩個(gè)詞之間添加一個(gè)空格，但僅此而已）。這同時(shí)意味著Java中的語(yǔ)句會(huì)在編譯器發(fā)現(xiàn)“;”符號(hào)時(shí)終止，而非在行末自動(dòng)終止。現(xiàn)在再來(lái)看看以上代碼。其全部寫(xiě)在一行當(dāng)中。由于這位同學(xué)在行前加了個(gè)“tab”，因此可以確定這一行屬于“if”語(yǔ)句。不過(guò)問(wèn)題仍然存在——if的本體究竟是什么？以下為答案，if的本體是：
if(a < EARLIEST_HOUR && b < EARLIEST_HOUR && c < EARLIEST_HOUR)
a = EARLIEST_HOUR; b = EARLIEST_HOUR; c = EARLIEST_HOUR;
就是這樣，只有“a”屬于條件本體。那么語(yǔ)句剩下的部分呢？它們對(duì)于“if”毫無(wú)意義，意味著其無(wú)論條件是否為真都會(huì)被執(zhí)行。如果這位學(xué)生認(rèn)為條件為真時(shí)三項(xiàng)分配會(huì)被全部執(zhí)行，那他就犯下了一個(gè)嚴(yán)重的邏輯錯(cuò)誤——代碼不可能實(shí)現(xiàn)這樣的效果，但卻很難看得出現(xiàn)。
另外，我們還發(fā)現(xiàn)了另外兩個(gè)問(wèn)題：
問(wèn)題三——條件為真時(shí)只有一次分配能夠切實(shí)執(zhí)行，而這與程序員的預(yù)期不符。
問(wèn)題四——將太多語(yǔ)句寫(xiě)進(jìn)同一行是種壞習(xí)慣。這并不是錯(cuò)誤，Java允許這種作法，但其會(huì)干擾我們的審查與判斷。
下面來(lái)看正確的代碼編寫(xiě)方式：
if(a < EARLIEST_HOUR && b < EARLIEST_HOUR && c < EARLIEST_HOUR) {
a = EARLIEST_HOUR;
b = EARLIEST_HOUR;
c = EARLIEST_HOUR;
}
總體來(lái)講——這里列舉的代碼示例非常糟糕，其中包含大量問(wèn)題且令程序員很難發(fā)現(xiàn)其中的錯(cuò)誤與bug。我的建議時(shí)，作為剛剛?cè)腴T(mén)的程序員，大家應(yīng)當(dāng)編寫(xiě)結(jié)構(gòu)更為清晰且簡(jiǎn)潔的代碼、正確使用空格、常量與縮進(jìn)等元素。
下面我們?cè)賮?lái)聊幾個(gè)大家可能感興趣的后續(xù)問(wèn)題：
· 在***的代碼示例中，我利用該條件的本體包含了三個(gè)語(yǔ)句。我們?cè)撊绾卫^續(xù)使用單行語(yǔ)句編寫(xiě)三次分配？如果不使用括號(hào)，又該如何實(shí)現(xiàn)？
· 我提到“8”是個(gè)無(wú)法解釋的“魔數(shù)”，但我并沒(méi)有提到該變量的名稱——a、b與c。您怎么看？這種命名方式是否也有問(wèn)題？
· 如果a、b或者c中僅有一個(gè)變量的值小于8，您認(rèn)為結(jié)果會(huì)如何？
原文鏈接：https://dzone.com/articles/bad-bad-code
原文標(biāo)題：Bad, Bad Code! (And Tips to Avoid It)
原文作者：Shay Tavor
【51CTO譯稿，合作站點(diǎn)轉(zhuǎn)載請(qǐng)注明原文譯者和出處為51CTO.com】
