我花了很多時間來敦促這些實習生去學習這些內容。我經常會問他們，怎麼樣才能成為一名優秀的程式設計師，他們也通常會回答說，程式碼應該清晰易懂易於維護。這的確是我想聽到的聲音，但是很少有年輕的程式設計師真的能夠始終如一地貫徹這一點。
請謹記這一點，要懂得“自我規範”，也不能一旦程式碼“起效了”就立馬置之腦後。如果所有的變數都命名錯誤，但是程式碼依然可以完美地執行，那麼這些程式碼絕對亂糟糟得讓人不忍直視。將功能程式碼改進為簡潔程式碼可能在短期內是看不到回報的：程式碼原本就可以工作，在清潔之後依然可以工作。這就是為什麼你需要“自我規範”這一步驟了。這也是為什麼實習工作是如此必要：一個好的上司是相當注重程式碼質量的（即使所謂“好程式碼”的定義對於每個程式設計師都不一樣），從而迫使實習生和初級程式設計師不得不反覆修改。
下面我舉的一些例子都是新手程式設計師寫程式碼的時候經常出現的：
名不副實的函式/變數/類
這些函式、類和變數實際所做的事與其名字所表達的含義並不一致。片面看名字是正確的，但是聯絡實際的話，有的甚至是毫不相關的。
舉個例子，我上一期的實習生寫了兩個類：EditorGUI和EditorObjectCreatorGUI。用於處理編輯介面的程式碼。讓我哭笑不得的是，用於建立新物件的是EditorGUI，而EditorObjectCreatorGUI只能通過處理不同的物件進行導航。兩者的含義居然是截然相反的！即使程式碼還算相對簡單，但我還是花了相當長的一段時間用來理解它，因為一開始我是在一種完全相反的假設基礎上來理解的。這種情況的解決方案非常簡單：重新命名EditorObjectCreatorGUI為EditorObjectNavigationGUI即可，這樣就易於理解多了。
這種情況我看到過很多。之所以會發生這種情況是因為程式碼在工作過程中發生了演變。在選擇名字的時候可能還是正確的，但到了寫完程式碼的那一刻，就名不副實了。關鍵是要時刻銘記命名法則。你得明白你新增的東西是否依然符合函式和類的名稱。
混亂的類
另一個問題是類很亂：類做了很多不相關的事情。新功能的新增很簡單，但是慢慢的，你會發現你的程式碼變得臃腫不堪，各種不相關的功能隨處可見。有時候，臃腫與否也並不指的是類的大小：某個類可能只有幾百行，但依然囊括了不屬於它的程式碼。
為什麼會發生這種情況呢？舉個例子：假設由於某種原因，某個GUI類需要分析什麼樣的紋理可行（可能是有按鈕要用來選擇紋理）。如果這個GUI類是唯一需要這個分析結果的類，那麼在GUI類中這樣做是有意義的。然而，由於某種原因，一個完全無關的gameplay類也需要這些資訊。所以你需要將這些紋理查詢的資訊從GUI類傳給gameplay類。這時候，其實這個GUI類已經變大了：因為它裡面其實還包括了TextureAnalyser類。解決方法也簡單：將TextureAnalyser類分割為一個單獨的類，GUI類和gameplay類都可以使用它。
關於這一條經驗法則很多人提出質疑：要是我新增的功能仍然適合原來這個類的名字呢？如果的確不適合，那麼我就必須重新命名，或者將其分割成單獨的類，抑或用程式碼寫成一個不同的類嗎？
如果你不能為你的類想出一個合適的名字，給人的感覺就會不舒服。如果你不能在類的名字中描述它的目的，那麼就會顯得亂七八糟。有時候我們還需要將某個臃腫的類分割成幾部分，並各自取一個恰當的名字。
過於龐大的類
這和上一點——混亂的類有些類似：很多東西一點一點地都新增到類中，然後它不可避免地就臃腫了。在這種情況下，這樣一個類仍然是有意義的，但就是長得太大個了點。這麼個龐然大物不但繁瑣，而且很容易出現bug，因為大量的程式碼需要用於操作同一個私有成員變數，所以我們很容易忽視一些細節。
分割一個已經長得很大的類其實是相當枯燥的。這也會成為一個挑戰，如果類中的程式碼高度交織在一起的話。再加上它已經在工作，修復時不能新增新功能，這樣一來，我不得說，分割一個過於龐大的類，不能嚴格地自我規範是不行的。
根據在Ronimo的普遍經驗，類保持在500行程式碼以下、函式保持在50行程式碼以下是最合適的。不過有時候，這樣做反倒不可行，也不明智。但是一般說來，一旦類或函式超出了那個界限我們就可以想辦法重構，並將之分割為更小更易於管理的片段了。
關於程式碼註釋
幾乎所有的示例程式碼都會包含註釋好了的程式碼片段，而不說明為什麼。這段程式碼需要修復嗎？舊的程式碼是否已經被取代了？為什麼那兒要寫這些程式碼？大家都知道沒有註釋的程式碼常常不知所言，但不知何故，很多人都會忘記在自己的程式碼上註釋。
並行邏輯和程式碼重複
還有一個問題就是我經常能在若干個程式碼段處看到相似的邏輯。
例如，我們可以從紋理這個名稱知道它大概的目標物件，比如說是“TreeBackground.dds”。為了知道紋理是否可以用於tree，我們檢查了檔名以便知道它是不是以“tree”開的頭。可能使用SDK的話我們用filename.beginsWith（“tree”）可以很快地檢測出來。只是這句程式碼這麼短，我們往往會選擇哪個地方需要，就直接複製貼上。當然這樣就是程式碼重複了，而正如每個人都知道的，我們應該避免重複程式碼，但如果複製的程式碼是如此之短，我們往往會忘記這一點，很自然地就直接copy了。此處我們面對的問題也是顯而易見的：也許後面我們檢查某個紋理是否適合tree的方法就得變了，然後我們就不得不實行“霰彈式修改”（即到處修改）策略，一處一處地修復。
此處的一般規律是，如果是非常具體的程式碼，那就不要複製，即使原本的程式碼超級之短，呼叫函式甚至比直接寫需要更多的程式碼，也應該封裝成函式。
上面討論的這些內容已經講得非常透徹了。很多內容甚至你在大學中就學過。但是現在要面臨的挑戰是你需要一步步地從被動遵守到主動銘記於心養成一種習慣。這也是為什麼Ronimo中的實習生最重要的不是學習知識，而是學會自我規範。
英文原文：What most young programmers need to learn
翻譯作者：碼農網 – 小峰
來自：碼農網
相關閱讀
評論(1)