|
|
有很多理由都能說明為什么我們應(yīng)該寫出清晰、可讀性好的程序。最重要的一點(diǎn)，程序你只寫一次，但以后會(huì)無(wú)數(shù)次的閱讀。當(dāng)你第二天回頭來看你的代碼時(shí)，你就要開始閱讀它了。當(dāng)你把代碼拿給其他人看時(shí)，他必須閱讀你的代碼。因此，在編寫時(shí)多花一點(diǎn)時(shí)間，你會(huì)在閱讀它時(shí)節(jié)省大量的時(shí)間。
讓我們看一些基本的編程技巧：
- 盡量保持方法簡(jiǎn)短
- 永遠(yuǎn)永遠(yuǎn)不要把同一個(gè)變量用于多個(gè)不同的目的
- 使用自描述的變量名和方法名
- 盡可能的把變量定義在靠近使用它的地方
- 拒絕神秘?cái)?shù)字
- 友好的對(duì)待你的語(yǔ)言
- 不要逆常規(guī)而行
- 警惕過早優(yōu)化
- 積極重構(gòu)測(cè)試過的程序
- 不要過度沉迷于技巧
- 通過習(xí)例學(xué)習(xí)新知
現(xiàn)在，讓我們把每個(gè)小點(diǎn)展開來詳細(xì)講一下。
1. 盡量保持方法簡(jiǎn)短
盡管很多人都遵循這個(gè)規(guī)則，但它仍然非常的重要。你寫的方法要始終能在一個(gè)屏幕里放得下。如果你需要去滾動(dòng)屏幕，這會(huì)分散你的注意力，而且你看不到整個(gè)的上下文。最佳長(zhǎng)度是5-20行，這根據(jù)你的情況而定。當(dāng)然，getters/setters 通常是一行代碼的方法，但與其說它們是真正的方法，不如說它們只是存取工具。
2. 永遠(yuǎn)永遠(yuǎn)不要把同一個(gè)變量用于多個(gè)不同的目的
一個(gè)變量應(yīng)該始終只為一個(gè)目的服務(wù)。通過使變量常量化(C++里的const， Java里的final)，使得編譯器能夠優(yōu)化編譯，而且使你的代碼醒目表達(dá)這個(gè)變量是不能改變的，你的程序的可讀性會(huì)變得更好。
3. 使用自描述的變量名和方法名
你的代碼應(yīng)該，對(duì)于任何人來說，只要看一眼就能知道是干嘛的。盡量不要用簡(jiǎn)寫方式，除非有特殊的習(xí)慣，就像下面的：
src - source
pos - position
prev - previous
如果你認(rèn)為描述性的名稱并不是那么有價(jià)值，請(qǐng)對(duì)比一下n, ns, nsisd 和 numTeamMembers, seatCount, numSeatsInStadium。
4. 盡可能的把變量定義在靠近使用它的地方
蓋房子時(shí)，你可不希望把錘子放到別人的院子里。你希望把它們放的離手頭越近越好。定義變量也是同樣的道理。
int foo = 3;
int bar = 5;
// 一大段使用“bar”的代碼，
// 但沒用到“foo”
// ...baz(foo);
這段代碼可以簡(jiǎn)單的重構(gòu)成
int bar = 5;
// 一大段使用“bar”的代碼，
// 但沒用到“foo”
// ...int foo = 3;
baz(foo);
當(dāng)你把變量的聲明和第一次用到它的地方間隔太遠(yuǎn)時(shí)(距離超過一個(gè)屏幕)，這確實(shí)會(huì)成為一個(gè)問題。記住上下文關(guān)系會(huì)變得困難，你需要滾動(dòng)屏幕去找哪來的這個(gè)變量。
5. 拒絕神秘?cái)?shù)字
當(dāng)你要把什么東西跟一個(gè)常量值做比較時(shí)，記得把這個(gè)值定義成常量。沒有什么會(huì)比去猜測(cè)你的同事寫的這樣的代碼更讓人頭疼的事了：
il < 4384
換個(gè)形式感覺如何？
inputLength < MAX_INPUT_LENGTH
6. 友好的對(duì)待你的語(yǔ)言
學(xué)習(xí)新語(yǔ)言是一種很有樂趣的事情，你能學(xué)到一種新的完成任務(wù)的途徑。當(dāng)一個(gè)對(duì)一種語(yǔ)言已經(jīng)很專業(yè)的人去學(xué)習(xí)另一種語(yǔ)言時(shí)，會(huì)出現(xiàn)一種很大的負(fù)面效應(yīng)。比如說你是一個(gè)Java開發(fā)者，試圖去學(xué)習(xí)Ruby。你應(yīng)該學(xué)會(huì)用Ruby的方式解決問題，而不是沿用Java的解決問題的思想。
當(dāng)你需要重復(fù)5遍”Hello world！“時(shí)，在Java里，你可能會(huì)這樣做：
for (int i = 0; i < 5; i++) {
System.out.println("Hello world!");
}
在Ruby里，你也許會(huì)禁不住這樣寫：
for i in (0..5)
puts "Hello world!"
end
這樣看起來沒問題，但有一個(gè)更好的方式：
5. times { puts "Hello world!" }
7. 不要逆常規(guī)而行
每種語(yǔ)言都有自己不同的習(xí)俗約定。一般來說，人們聽的最多的是Java的編碼規(guī)范。讓我們看看其中的一些習(xí)俗規(guī)范：
- 方法名應(yīng)該小寫字母開頭，其后用字母大寫的單詞連接(
veryLongVariableName) - 類名應(yīng)該都使用首字母大寫的單詞連接而成
- 常量名應(yīng)該全部大寫，用下劃線連接(
MY_CONSTANT) - 左大括號(hào)應(yīng)該跟 if 語(yǔ)句在同一行
只有在有必要的理由時(shí)才去打破這些常規(guī)，不要輕易的因?yàn)槟悴桓吲d就違反它。如果你只是在團(tuán)隊(duì)里改變一些這樣的習(xí)慣，那也沒問題，但當(dāng)把你代碼拿出來和其他的沒有這些思想準(zhǔn)備的程序員共享時(shí)，問題就會(huì)來了。
8. 警惕過早優(yōu)化
過早優(yōu)化是所有問題的根源，至少電視上是這么說的 … 你第一應(yīng)該關(guān)心的事情是寫出易于理解的代碼。起初寫的程序不要求快。除非你的程序很慢，否則談優(yōu)化都是為時(shí)太早。如果你想優(yōu)化什么東西，你首先需要知道問題出在哪。這就是我們需要profilers這個(gè)工具的原因。
在沒有知道問題在哪的情況下試圖對(duì)程序進(jìn)行優(yōu)化，其結(jié)果必然是把程序能壞，至少你的代碼會(huì)喪失可讀性。如果你覺得有些地方很慢，不要盲目的重寫代碼，你應(yīng)先找到慢的證據(jù)。
不要傻乎乎的去解決根本不存在的問題。
9. 積極重構(gòu)測(cè)試過的程
沒有任何東西會(huì)是完美的。即使你感覺你真正寫出了一段完美的代碼，幾個(gè)月后回頭再看看，你可能會(huì)驚訝道”怎么會(huì)這樣傻？“
改進(jìn)程序的一個(gè)好方法就是重構(gòu)，但要等程序測(cè)試通過之后。你首先要確保程序是好的可運(yùn)行的，你可以通過自動(dòng)化測(cè)試或手工測(cè)試完成這個(gè)工作。
之初，你需要的是程序可用。不要期望在第一次就寫出完美的程序，你只需要把它寫出來，可用。然后重構(gòu)它，使之完美。對(duì)于你們當(dāng)中知道測(cè)試驅(qū)動(dòng)開發(fā)(TDD)的人來說，對(duì)這個(gè)會(huì)很熟悉。這里的關(guān)鍵就在于你要習(xí)慣于重構(gòu)這種事情。如果你使用的是像IntelliJ IDEA這樣強(qiáng)大的集成開發(fā)工具的話，重構(gòu)的工作會(huì)變得簡(jiǎn)單的多。
重構(gòu)之后，你也許會(huì)弄出一些Bug，導(dǎo)致某些功能出問題。這就是為什么說寫自動(dòng)化測(cè)試的原因。不論何時(shí)重構(gòu)后，只要運(yùn)行一下所有的測(cè)試用例，你就能準(zhǔn)確的知道什么地方出了問題。
10. 不要過度沉迷于技巧
當(dāng)我第一次讀到有關(guān)設(shè)計(jì)模式的知識(shí)時(shí)，我覺得我找到了圣杯。這些精心設(shè)計(jì)的思想作用顯著，它能使你的設(shè)計(jì)易于理解，因?yàn)槟憧梢院?jiǎn)單的說”我使用的是‘觀察器模式’“，而不用從頭到尾的解釋一遍。那么，有問題嗎？一切看起來都這么自然、簡(jiǎn)單，你開始不論在哪都使用設(shè)計(jì)模式。為什么不把這個(gè)類做成singleton呢？干嘛不去再創(chuàng)建一些工廠類呢？
于是一個(gè)80行就能寫完的腳本，你最終使用了10個(gè)類，15個(gè)接口，外加一大堆范式和標(biāo)記符。97%的代碼不做任何事情。設(shè)計(jì)模式是一種十分有用的用來簡(jiǎn)化你的設(shè)計(jì)的工具，但這不意味著你該在所有能用到的地方都用它。你應(yīng)該用它們，但不能濫用。
11. 通過習(xí)例學(xué)習(xí)新知
編程是一種學(xué)習(xí)新知的過程。當(dāng)你學(xué)到了新的程序庫(kù)或新語(yǔ)言，你可能會(huì)迫不及待的丟掉舊的代碼，用你新學(xué)到的東西重新寫一遍。有很多的理由都能說明你不該這么做。
往現(xiàn)有的應(yīng)用里增加新的類庫(kù)或框架同屬于這種情況。就說你寫了一個(gè)Javascript的web應(yīng)用，期間，你發(fā)現(xiàn)了jQuery。現(xiàn)在你突然急切的想丟到你的Javascript程序，重新用jQuery寫，盡管你還從來沒用過它。
最好的方式是你先用jQuery寫一些簡(jiǎn)單的例子，通過這種方式把你在應(yīng)用里將要用到的知識(shí)都學(xué)會(huì)。需要AJAX？在你的項(xiàng)目之外做一些小例子，當(dāng)完全弄懂了后，丟掉例子，應(yīng)用到你的產(chǎn)品里。
如果你非常關(guān)注編程技術(shù)，我強(qiáng)烈的推薦你閱讀Steve McConnell寫的 《代碼大全》 一書。它會(huì)永遠(yuǎn)的改變你對(duì)編程的認(rèn)識(shí)。:)
[英文出處]：11 tips for better code
it知識(shí)庫(kù)：改良程序的11技巧，轉(zhuǎn)載需保留來源！
鄭重聲明：本文版權(quán)歸原作者所有，轉(zhuǎn)載文章僅為傳播更多信息之目的，如作者信息標(biāo)記有誤，請(qǐng)第一時(shí)間聯(lián)系我們修改或刪除，多謝。
