有很多理由都能說明為什么我們應(yīng)該寫出清晰、可讀性好的程序。最重要的一點(diǎn),程序你只寫一次,但以后會(huì)無數(shù)次的閱讀。當(dāng)你第二天回頭來看你的代碼時(shí),你就要開始閱讀它了。當(dāng)你把代碼拿給其他人看時(shí),他必須閱讀你的代碼。因此,在編寫時(shí)多花一點(diǎn)時(shí)間,你會(huì)在閱讀它時(shí)節(jié)省大量的時(shí)間。
讓我們看一些基本的編程技巧:
1. 盡量保持方法簡短
盡管很多人都遵循這個(gè)規(guī)則,但它仍然非常的重要。你寫的方法要始終能在一個(gè)屏幕里放得下。如果你需要去滾動(dòng)屏幕,這會(huì)分散你的注意力,而且你看不到整個(gè)的上下文。最佳長度是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)該,對于任何人來說,只要看一眼就能知道是干嘛的。盡量不要用簡寫方式,除非有特殊的習(xí)慣,就像下面的:
src - source
pos - position
prev - previous
如果你認(rèn)為描述性的名稱并不是那么有價(jià)值,請對比一下n, ns, nsisd 和numTeamMembers, seatCount, numSeatsInStadium。
4. 盡可能的把變量定義在靠近使用它的地方
蓋房子時(shí),你可不希望把錘子放到別人的院子里。你希望把它們放的離手頭越近越好。定義變量也是同樣的道理。
int foo = 3;
int bar = 5;
// 一大段使用“bar”的代碼,
// 但沒用到“foo”
// ...
baz(foo);
這段代碼可以簡單的重構(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ì)比去猜測你的同事寫的這樣的代碼更讓人頭疼的事了:
il < 4384
換個(gè)形式感覺就會(huì)發(fā)生很大的變化:
inputLength < MAX_INPUT_LENGTH