聊聊程式碼質量 - 《學得會,抄得走的提升前端程式碼質量方法》前言
阿新 • • 發佈:2021-11-23
程式碼質量對公司和個人都很重要。
對公司來說,公司期望高質量的產品。程式碼質量會直接體現到產品質量上。程式碼質量差往往會導致產品質量差。同時,公司期望開發產品的速度快。程式碼質量好,有利於提升開發速度。反之,改程式碼質量差的程式碼,就像在保持不塌的情況下,移動岌岌可危的樂高搭的高樓中的積木,速度快不起來。
對個人來說,程式碼質量是程式設計師專業能力的體現。能寫出高質量的程式碼,有助於找到好工作和升職加薪。
因此,我們都期望提升程式碼質量。
提升程式碼質量的方法
提高程式碼質量的方法有很多,比如:
- 統一程式碼風格。
- 給檔案,類,函式,變數等起有意義的名字。
- 在必要的地方加註釋。
- 合理的使用程式設計方法論。DDD(領域驅動設計),面向物件程式設計,函數語言程式設計。
- 合理的使用設計原則和設計模式。
- 寫測試用例。
- 持續整合。
- 程式碼掃描。
- Code Review。
- 結對程式設計。
- 挑選高質量的第三方庫。
- ...
方法這麼多,在時間和資源有限的情況下,我們該做哪些?以及做的先後順序是怎樣的?
提升程式碼質量的順序
《學得會,抄得走的提升前端程式碼質量方法》系列文章是對上面問題的回答。
程式碼質量由 3 個部分組成:
- 實現業務功能。
- 程式碼的可讀性。
- 程式碼的複雜度。
高質量的程式碼首先是實現了業務功能的,然後有很好的可讀性,最後,程式碼的複雜度控制在一個可接受的範圍。提高程式碼質量的方法,都可以歸類為這 3 個部分。系列文章根據這 3 個部分,將程式碼質量從壞到好為 5 個階段。如下圖所示:
提升程式碼質量,應該從下層往上層做。
程式碼的價值在於實現業務功能。不能實現業務功能的程式碼,寫的再好也沒有價值。因此,程式碼首先要實現業務功能。
讀程式碼是個高頻操作。每次改程式碼前,都會讀程式碼。同時,提升程式碼的可讀性,成本不是很高。從投入產出的角度來看,提升程式碼可讀性的價效比高。
最後,就是降低程式碼的複雜度。要降低程式碼的複雜度,需要花大量時間去做調研和設計,往往還會走一些彎路。降低複雜系統的複雜度,對團隊和個人來說,都是一個挑戰。因此,把這塊放到最後。
文章會詳細介紹每個階段的特徵,以及如何達到的方法。
歡迎點選一鍵訂閱《雲薦大咖》專欄,獲取更多精品內容。
看雲端技術起落,聽大咖指點迷津。