有很多理由都能說明為什么我們應該寫出清晰、可讀性好的程序。最重要的一點,程序你只寫一次,但以后會無數次的閱讀。當你第二天回頭來看你的代碼時,你就要開始閱讀它了。當你把代碼拿給其他人看時,他必須閱讀你的代碼。因此,在編寫時多花一點時間,你會在閱讀它時節省大量的時間。
讓我們看一些基本的編程技巧:
1. 盡量保持方法簡短
盡管很多人都遵循這個規則,但它仍然非常的重要。你寫的方法要始終能在一個屏幕里放得下。如果你需要去滾動屏幕,這會分散你的注意力,而且你看不到整個的上下文。最佳長度是5-20行,這根據你的情況而定。當然,getters/setters 通常是一行代碼的方法,但與其說它們是真正的方法,不如說它們只是存取工具。
2. 永遠永遠不要把同一個變量用于多個不同的目的
一個變量應該始終只為一個目的服務。通過使變量常量化(C++里的const, Java里的final),使得編譯器能夠優化編譯,而且使你的代碼醒目表達這個變量是不能改變的,你的程序的可讀性會變得更好。
3. 使用自描述的變量名和方法名
你的代碼應該,對于任何人來說,只要看一眼就能知道是干嘛的。盡量不要用簡寫方式,除非有特殊的習慣,就像下面的:
src - source
pos - position
prev - previous
如果你認為描述性的名稱并不是那么有價值,請對比一下n, ns, nsisd 和numTeamMembers, seatCount, numSeatsInStadium。
4. 盡可能的把變量定義在靠近使用它的地方
蓋房子時,你可不希望把錘子放到別人的院子里。你希望把它們放的離手頭越近越好。定義變量也是同樣的道理。
int foo = 3;
int bar = 5;
// 一大段使用“bar”的代碼,
// 但沒用到“foo”
// ...
baz(foo);
這段代碼可以簡單的重構成
int bar = 5;
// 一大段使用“bar”的代碼,
// 但沒用到“foo”
// ...
int foo = 3;
baz(foo);
當你把變量的聲明和第一次用到它的地方間隔太遠時(距離超過一個屏幕),這確實會成為一個問題。記住上下文關系會變得困難,你需要滾動屏幕去哪找來的這個變量。
5. 拒絕神秘數字
當你要把什么東西跟一個常量值做比較時,記得把這個值定義成常量。沒有什么會比去猜測你的同事寫的這樣的代碼更讓人頭疼的事了:
il < 4384
換個形式感覺就會發生很大的變化:
inputLength < MAX_INPUT_LENGTH