工程效率篇-如何更好地維護項目

前言

項目的初期有可能爲了儘快的落地實現功能,對項目中一些邊界的約束並無很好的考量.隨着項目代碼量的增加,代碼的質量是決定一個項目是否能長期良好發展的關鍵因素.項目的維護更像是短時間時間與將來時間權衡的過程.下面是本身對如何更好的維護代碼的一些思考.

維護項目的一些方向

項目的底層設計

項目的功能愈來愈龐大的時候,須要更多的功能模塊來支持業務模塊的運行.應該儘早的創建功能模塊的隔離和分層,能有效的防止功能模塊的耦合從而提升系統的可維護性.
經過將相同的功能進行提取

對不一樣的模塊進行隔離,單獨維護

文檔

1. 梳理項目中關鍵技術的文檔,quick Start等,有利於團隊的新人快速的接入項目進行開發.
2. 通用的api,工具等能夠經過jsDoc等工具生成閱讀性強的文檔.
3. 在進入開發前思考相應的實現而且經過文檔的方式呈現.

提升可讀性

在提升可讀性上並無一個徹底的最佳實踐.須要儘快的找到適合整個團隊的方案.提升可讀性能夠有如下的幾個方向:

1. 儘早的創建編程規範而且經過工具去約束編程規範,例如VS Code生成代碼片斷、eslint、husky、commitizen等.
   husky能夠在特定的git hooks執行用戶指定的行爲.
   
   commitizen能夠輔助生成規範化的git commit.
   
2. review機制
   長期有效的review機制能有效的減小團隊出現case的機率而且有利於團隊造成統一的代碼風格和吸取優秀的案例.

減小重複工做

1. 思考如何寫的更少.一樣模式的代碼是否能夠進行抽象來進行整合.
2. 模塊的提取(組件, utils).

引入自動化測試

在關鍵路徑上引入自動化的測試流程.

參考

代碼質量與規範，那些年你欠下的技術債
好的提升代碼質量的方法有哪些

                                           

                                           歡迎你們關注個人微信公衆號,一塊兒學習