整潔程式碼的4個提示

雖然這樣的文章非常的多，並且，就算是對於程式設計新手來說，也是非常的簡單和顯而見，但是，在我們進行Code Review過程中，我們還是能夠看到那些非常混亂的程式碼，所以，有些時候，你會在想，是不是這樣的規則太多了，導致我們的程式設計師記不住。雖然我們在以前的文章中一遍又一遍的說過（比如：《優質程式碼的十誡》），千言萬語總結一下，無論你用什麼樣的語言，最最基本的程式設計原則就是下面這四條。

 

1 – 簡短的方法

簡單才會易讀，簡單才會容易，簡單才能重用，簡單才能保證質量。把一件事搞複雜，是一件簡單的事；而把一件事變簡單，這則是一件複雜的事。KISS-Keep it Simple Stupid是一種哲學，Do one thing, Do it best也是一種哲學。這些都是在告訴我們，做設計，做產品，不要把所有的東西一下子都考慮進來，否則將會讓你的事情變成一團糟，剪不斷理還亂，就是這樣道理。把複雜的事情，困難的事情，逐步細化，分解成一個一個簡單而單一的事情，然後再把他們拼裝起來完成一個複雜的事情，是我們如何完成一個巨大並複雜的專案的通用方法。

程式設計也是這個道理，維護程式碼的成本會比你創造程式碼的成本要大得多，所以，一個簡短的方法不但可以有利於閱讀，維護，重用，同樣在進行排錯除錯測試的時候也能起到巨大的幫助。比如，對於一個簡單的方法或函式，單元測試，功能測試，效能測試、程式碼覆蓋，質量保證都能變得相當簡單，而這些眾多的質量優良的方法最終組成了那質量過硬的最終產品，並讓我們在以後的程式碼不斷改進中繼續充當重要的作用。

2 – 選擇望文知意的直觀的變數名和函式名

無論是變數名還是方法名，都不能太長或是太短。一個好的命名，應該是“自解釋的”，直觀的，望文知意的。通常來說，一個好的命名應該是知道這個變數/方法要幹什麼事情，比如GetComputerName()，isAdmin等等，對於變數名來說，通過其名字，我們可以知道這個變數的型別（整型，浮點，指標，……），種類（全域性，成員，區域性，靜態，……）。關於命名的事情，可以檢視《程式設計命名中的7+1個提示》和《程式設計中的命名設計那點事》檢視更多的內容。

3 – 只寫有意義的註釋

程式碼寫得好的話，是不需要註釋的。與其花費大量的時候去寫註釋，還不如把這些時間花在程式碼重構上，簡潔/易讀的程式碼比詳細的註釋更有意義。另外，如果你需要使用你的註釋來生成文件，那麼也不需要太過複雜，這通常用來做API的文件，這個時候，關鍵不在於你是如何實現的，而是在於告訴別人完成什麼樣的事並如何使用之。總之，一句話，如果你的程式碼足夠的簡單和清楚，你是不需要寫註釋的。
4 – 讓你的程式碼可讀

你的程式碼並不只是讓編譯器去閱讀的，你的程式碼更應該是讓你的同事和其它人閱讀的。所以，一定要遵守團隊內部的那些最中規中矩的程式設計規範或程式碼風格，千萬不要在程式碼中使你的小聰明或是偷懶或是hack程式碼，那樣做的結果只會有兩個，一個是你的程式碼會被後人罵得一無是處，另一個就是當你在以後維護你的程式碼時無異於搬起石頭砸了自己的腳。編碼堅持最基本的兩個原則—— KISS 和DRY，剩下的就是順從於自然。

（全文完）

 

 

作者： 陳皓

原文連線; http://coolshell.cn/?p=1095

<script type="text/javascript"></script>