如何改良你的程序代碼質量的11個技巧

　　有很多理由都能說明為什么我們應該寫出清晰、可讀性好的程序。最重要的一點，程序你只寫一次，但以后會無數次的閱讀。當你第二天回頭來看你的代碼時，你就要開始閱讀它了。當你把代碼拿給其他人看時，他必須閱讀你的代碼。因此，在編寫時多花一點時間，你會在閱讀它時節省大量的時間。

　　讓我們看一些基本的編程技巧：

　　盡量保持方法簡短

　　永遠永遠不要把同一個變量用于多個不同的目的

　　使用自描述的變量名和方法名

　　盡可能的把變量定義在靠近使用它的地方

　　拒絕神秘數字

　　友好的對待你的語言

　　不要逆常規而行

　　警惕過早優化

　　積極重構測試過的程序

　　不要過度沉迷于技巧

　　通過習例學習新知

　　現在，讓我們把每個小點展開來詳細講一下。

　　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

　　6. 友好的對待你的語言

　　學習新語言是一種很有樂趣的事情，你能學到一種新的完成任務的途徑。當一個對一種語言已經很專業的人去學習另一種語言時，會出現一種很大的負面效應。比如說你是一個Java開發者，試圖去學習Ruby。你應該學會用Ruby的方式解決問題，而不是沿用Java的解決問題的思想。

　　當你需要重復5遍”Hello world!“時，在Java里，你可能會這樣做：

　　for (int i = 0; i < 5; i++) {

　　System.out.println("Hello world!");

　　}

　　在Ruby里，你也許會禁不住這樣寫：

　　for i in (0..5)

　　puts "Hello world!"

　　end

　　這樣看起來沒問題，但有一個更好的方式：

　　5.times { puts "Hello world!" }

　　7. 不要逆常規而行

　　每種語言都有自己不同的習俗約定。一般來說，人們聽的最多的是Java的編碼規范。讓我們看看其中的一些習俗規范：

　　方法名應該小寫字母開頭，其后用字母大寫的單詞連接(veryLongVariableName)

　　類名應該都使用首字母大寫的單詞連接而成

　　常量名應該全部大寫，用下劃線連接(MY_CONSTANT)

　　左大括號應該跟 if 語句在同一行

　　只有在有必要的理由時才去打破這些常規，不要輕易的因為你不高興就違反它。如果你只是在團隊里改變一些這樣的習慣，那也沒問題，但當把你代碼拿出來和其他的沒有這些思想準備的程序員共享時，問題就會來了。

　　8. 警惕過早優化

　　過早優化是所有問題的根源，至少電視上是這么說的 … 你第一應該關心的事情是寫出易于理解的代碼。起初寫的程序不要求快。除非你的程序很慢，否則談優化都是為時太早。如果你想優化什么東西，你首先需要知道問題出在哪。這就是我們需要profilers這個工具的原因。

　　在沒有知道問題在哪的情況下試圖對程序進行優化，其結果必然是把程序能壞，至少你的代碼會喪失可讀性。如果你覺得有些地方很慢，不要盲目的重寫代碼，你應先找到慢的證據。

　　不要傻乎乎的去解決根本不存在的問題。

　　9. 積極重構測試過的程序

　　沒有任何東西會是完美的。即使你感覺你真正寫出了一段完美的代碼，幾個月后回頭再看看，你可能會驚訝道”怎么會這樣傻?“

　　改進程序的一個好方法就是重構，但要等程序測試通過之后。你首先要確保程序是好的可運行的，你可以通過自動化測試或手工測試完成這個工作。

　　之初，你需要的是程序可用。不要期望在第一次就寫出完美的程序，你只需要把它寫出來，可用。然后重構它，使之完美。對于你們當中知道測試驅動開發(TDD)的人來說，對這個會很熟悉。這里的關鍵就在于你要習慣于重構這種事情。如果你使用的是像IntelliJ IDEA這樣強大的集成開發工具的話，重構的工作會變得簡單的多。

原文轉自：http://www.aqee.net/11-tips-for-better-code/