30 多年的軟體經驗,總結出 10 個編寫出更好程式碼的技巧
30 多年的軟體經驗,總結 10 個最佳妙招。
那麼,何以敲出一手好程式碼?
好程式碼可以定義為易讀、易懂、易除錯、易改,最重要的還要少缺陷。顯然,要想敲出一手好程式碼,是要花不少時間,但這在長久來看是有意義的,因為你可以花更少時間及精力去維護和複用你的程式碼。
事實上,我們可以將好程式碼等同於可複用的程式碼,這也是下面提到的重要原則之一。程式碼可能只是完成了程式設計工作中短期目標的特定功能,但如果沒人(包括你自己)願意複用你的程式碼,這程式碼在某種程度上可以說是不足且有缺陷的。要麼太複雜、要麼太具體、要麼在不同情況下極有可能崩掉,或者其他程式設計師可能不相信你的程式碼。
下面無論你的經驗水平如何,如果你始終如一地將下面的妙招應用到你的程式碼中(包括你的實驗或者原型),那麼一手好程式碼隨手可得。
1、 遵循單一責任原則
函式在程式設計師的庫中是單一最重要的抽象形式。可以被複用的機會越多,你要寫的程式碼就越少,這些程式碼就越可靠。遵循單一責任原則的小小函式更有可能被重新使用。
2、最小化共享狀態
應該將函式之間的隱式共享狀態最小化,無論它是檔案作用域變數還是物件的成員欄位,這有利於顯式地將所需的值作為引數。當明確函式實現所需結果時,程式碼變得容易理解和重用。
對此可以得出一個結論,你應該優先選擇靜態無狀態變數而不是物件的成員變數。
3、本地化副作用
理想的副作用(例如列印到控制檯、記錄、改變全域性狀態、檔案系統操作等)應該放置在單獨的模組中,而不是分散在整個程式碼中。功能上的副作用往往違反了單一的責任原則。
4、優先選擇不可變的物件
如果一個物件的狀態在其建構函式中設定一次,並且不再次更改,則除錯變得容易得多,因為一旦構造正確就保持有效。這是降低軟體專案複雜性的最簡單方法之一。
5、多用介面少用類
接受介面的函式(或C++中的模板引數或概念)比在類上操作的函式可重用性更強。
6、對模組應用良好的原則
將軟體專案分解成更小的模組(例如庫和應用程式),以實現模組化重用。模組的一些關鍵原則是:
- 最小化依賴關係
- 每個專案都應該有一個單一明確的功能
- 不要重複
你應該努力讓你的專案保持小巧和明確。
7.避免繼承
在物件導向程式設計中,繼承,特別是虛擬函式在可重用性方面往往是一個死穴。我很少能成功地使用能覆蓋類的庫。
8.同設計和開發一樣進行測試
我並不是測試驅動開發的鐵桿擁護者,但在你開始編寫測試程式碼時,編寫測試自然遵循了許多指導方針。它也有助於早點將錯誤暴露出來。避免編寫無用的測試,良好的編碼意味著更高階的測試(例如,單元測試中的整合測試或功能測試)在顯示缺陷方面更有效。
9.優先選擇而不是手寫標準庫
我無法告訴你需要多久才能看到一個 std :: vector 或 std :: string 更好的版本,但它幾乎總是浪費時間和精力。除了一個顯而易見的事實,那就是你正在把 bug 引入一個新的地方。(見技巧10)其他程式設計師不太可能重用您的程式碼,而不是那些被廣泛理解、支援和測試的程式碼。
10.避免寫新程式碼
最重要的一點是,每位程式設計師應遵循:“The best code is the code that isn’t written”(最好的程式碼是不用被複寫的程式碼)。你的程式碼越多,缺陷就越多,找到並修復 bug 就越困難。
在編寫一行程式碼之前先問問自己,有沒有一個工具,函式或庫已經做了你所需要的功能?你真的需要自己去實現這個功能,而不是呼叫另一個已經存在的功能嗎?
總結
程式設計就好比是一種藝術形式或者一項運動,你只有通過不斷地練習,不斷地向他人學習,才能不斷地提高程式碼的質量,這些都將有利於你成為更加高效的程式設計師。
原文:10 Tips for Writing Better Code
作者:Christopher Diggins
翻譯:陳雲龍
相關文章
- 30 多年的編碼經驗總結成 10 條最佳實踐
- 多年經驗總結,寫出最驚豔的 Markdown 高階用法
- 用jQuery編寫出更好的程式碼jQuery
- 寫好Java程式碼的30條經驗總結Java
- 30多年程式設計師生涯經驗總結程式設計師
- 30 多年的編碼經驗濃縮成的 10 條最佳實踐
- 高效的jQuery程式碼編寫技巧總結jQuery
- 如何寫出更好的 React 程式碼?React
- 如何寫出更好的Java程式碼Java
- 編寫優秀程式碼的10個技巧
- 編寫更好程式碼的 6 個提示
- 【譯】如何寫出更好的 React 程式碼React
- [譯] 如何寫出更好的 React 程式碼?React
- Java程式碼編寫、程式碼優化技巧總結Java優化
- 關於ios多年面試的經驗總結iOS面試
- 程式設計師如何寫出更好的程式碼程式設計師
- 編寫更好的CSS程式碼CSS
- Google 的軟體工程經驗總結Go軟體工程
- 編寫更好程式碼的6個提示【已翻譯100%】
- SOHO設計師的多年工作經驗總結
- 5款工具助你寫出更好的Java程式碼Java
- 編寫更好的C#程式碼C#
- 五個小技巧讓你寫出更好的 JavaScript 條件語句JavaScript
- 《軟體專案經驗總結》
- 編寫靜態頁面經驗總結
- 編寫更好的 Java 單元測試的 7 個技巧Java
- 編寫更好的jQuery程式碼的建議jQuery
- Code Review 從失敗中總結出來的幾個經驗View
- Linux編寫Bash指令碼的10個技巧Linux指令碼
- 怎樣寫出漂亮整潔的程式碼?聊聊 Clean Code 的編碼、重構技巧
- [譯] 五個小技巧讓你寫出更好的 JavaScript 條件語句JavaScript
- 寫出高質量程式碼的10個建議
- 寫出高質量程式碼的10個Tips
- 老程式設計師的10個程式設計小技巧,教你寫出高質量程式碼!程式設計師
- 【譯】編寫更好JavaScript條件語句的5個技巧JavaScript
- 軟體反破解技術經驗總結:歡迎加入您的經驗
- 編寫更好 Bash 指令碼的 8 個建議指令碼
- 如何編寫出擁抱變化的程式碼?