聊聊代碼質量 - 《學得會,抄得走的提升前端代碼質量方法》前言

 

 

代碼質量對公司和個人都很重要。

對公司來說,公司期望高質量的產品。代碼質量會直接體現到產品質量上。代碼質量差往往會導致產品質量差。同時,公司期望開發產品的速度快。代碼質量好,有利於提升開發速度。反之,改代碼質量差的代碼,就像在保持不塌的情況下,移動岌岌可危的樂高搭的高樓中的積木,速度快不起來。

對個人來說,代碼質量是程序員專業能力的體現。能寫出高質量的代碼,有助於找到好工作和升職加薪。

因此,我們都期望提升代碼質量。

提升代碼質量的方法

提高代碼質量的方法有很多,比如:

  1. 統一代碼風格。
  2. 給文件,類,函數,變量等起有意義的名字。
  3. 在必要的地方加註釋。
  4. 合理的使用編程方法論。DDD(領域驅動設計),面向對象編程,函數式編程。
  5. 合理的使用設計原則和設計模式。
  6. 寫測試用例。
  7. 持續集成
  8. 代碼掃描。
  9. Code Review。
  10. 結對編程。
  11. 挑選高質量的第三方庫。
  12. ...

方法這麼多,在時間和資源有限的情況下,我們該做哪些?以及做的先後順序是怎樣的?

提升代碼質量的順序

《學得會,抄得走的提升前端代碼質量方法》系列文章是對上面問題的回答。

代碼質量由 3 個部分組成:

  1. 實現業務功能。
  2. 代碼的可讀性。
  3. 代碼的複雜度。

高質量的代碼首先是實現了業務功能的,然後有很好的可讀性,最後,代碼的複雜度控制在一個可接受的範圍。提高代碼質量的方法,都可以歸類爲這 3 個部分。系列文章根據這 3 個部分,將代碼質量從壞到好爲 5 個階段。如下圖所示:

提升代碼質量,應該從下層往上層做。

代碼的價值在於實現業務功能。不能實現業務功能的代碼,寫的再好也沒有價值。因此,代碼首先要實現業務功能。

讀代碼是個高頻操作。每次改代碼前,都會讀代碼。同時,提升代碼的可讀性,成本不是很高。從投入產出的角度來看,提升代碼可讀性的性價比高。

最後,就是降低代碼的複雜度。要降低代碼的複雜度,需要花大量時間去做調研和設計,往往還會走一些彎路。降低複雜系統的複雜度,對團隊和個人來說,都是一個挑戰。因此,把這塊放到最後。

文章會詳細介紹每個階段的特徵,以及如何達到的方法。

 

 

 歡迎點擊一鍵訂閱《雲薦大咖》專欄,獲取更多精品內容。

看雲端技術起落,聽大咖指點迷津。

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章