30 多年的編碼經驗濃縮成的 10 條最佳實踐

發表於2017-08-30

所以,如何寫出一手好程式碼?

良好的程式碼更易於閱讀、理解、除錯和修改,最重要的是它的缺陷也更少。顯然,編寫良好的程式碼需要更多的時間,但是從長遠來看,它也具有更多的價值,因為這降低了維護的成本,而且具有更好的可重用性。

事實上,我們可以將好的程式碼等同為可重用的程式碼,這也是本篇文章羅列的許多技巧背後的驅動原則。作為一個要實現特定功能的開發者,程式碼可以實現你的短期目標,但如果沒有其他人希望重用它(包括未來的自己),這些程式碼一定會缺失某些東西。無論它是太複雜,還是太具體,在不同情況下都有很大可能會出錯,或者不被其他開發者信任。

我發現,只要嘗試堅持將下面的最佳實踐應用於你編寫的所有程式碼(包括你的實驗和原型),無論你現在的經驗水平如何,都會編寫出更好的程式碼。

1. 遵循單一職責原則

函式是程式設計師的工具中最重要的抽象形式。它們能更多地被重複使用,你需要編寫的程式碼就越少,程式碼也因此變得更可靠。較小的函式遵循單一職責原則更有可能被重複使用。

2. 儘量減少共享狀態

你應該儘量減少函式之間的隱式共享狀態,無論它是檔案作用域的變數還是物件的成員欄位,這有利於明確要求把值作為引數。當能明確地顯示函式需要什麼才可以產生所需的結果時,程式碼會變得更容易理解和重用。

對此的一個推論是,在一個物件中,相對於成員變數,你更應該優先選擇靜態的無狀態變數 (static stateless variables)。

3. 將“副作用”區域性化

理想的副作用(例如:列印到控制檯、日誌記錄、更改全域性狀態、檔案系統操作等)應該被放置到單獨的模組中,而不是散佈在整個程式碼裡面。函式中的一些“副作用”功能往往違反了單一職責原則。

4. 優先使用不變的物件

如果一個物件的狀態在其建構函式中僅被設定一次,並且從不再次更改,則除錯會變得更加容易,因為只要構造正確就能保持有效。這也是降低軟體專案複雜性的最簡單方法之一。

5. 多用介面少用類

接收介面的函式(或 C++ 中的模板引數和概念)比在類上執行的函式更具可重用性。

6. 對模組應用良好的原則

尋找機會將軟體專案分解成更小的模組(例如庫和應用程式),以促進模組級別的重用。對於模組,應該遵循的一些關鍵原則是:

  1. 儘可能減少依賴
  2. 每個專案應該有一個明確的職責
  3. 不要重複自身

你應該努力使你的專案保持小巧和明確。

7. 避免繼承

在物件導向程式設計中,繼承 —— 特別是和虛擬函式結合使用時,在可重用性方面往往是一條死衚衕。我很少有成功的使用或編寫過載類的庫的經歷。

8. 將測試作為設計和開發的一部分

我不是測試驅動開發的堅定分子,但開始編碼時先編寫測試程式碼會使得程式碼十分自然地遵循許多指導原則。這也有助於儘早發現錯誤。不過要注意避免編寫無用的測試,良好的編碼實踐意味著更高階別的測試(例如單元測試中的整合測試或特徵測試)在揭示缺陷方面更有效。

9. 優先使用標準庫而不是手寫的

我經常看到更好版本的 std::vector 或 std::string,但這幾乎總是浪費時間和精力。一個明顯的事實是 —— 你正在為一個新的地方引入 bug,其他開發者也不太可能重用你的程式碼,因為沒有被廣泛理解、支援和測試。

10. 避免編寫新的程式碼

這是每個程式設計師都應遵循的最重要的教誨:最好的程式碼就是還沒寫的程式碼。你寫的程式碼越多,你將遇到的問題就越多,查詢和修復錯誤就越困難。

在寫一行程式碼之前先問一問自己,有沒有一個工具、函式或者庫已經實現了你所需要的功能?你真的需要自己實現這個功能,而不是呼叫一個已經存在的功能嗎?

寫在最後的話

我發現程式設計是一門與學習藝術或運動非常相似的技能,你通過刻意的練習和從別人的經驗中學習會得到更好的結果。不斷提升你產出的程式碼質量有助於你成為更優秀的程式設計師。

相關文章