點擊上方 [ 全棧開發(fā)者社區(qū) ] → 右上角 [...] → [設(shè)為 星標(biāo)? ]
好的代碼一定是整潔的，并且能夠幫助閱讀的人快速理解和定位。好的代碼可以加快應(yīng)用的開發(fā)迭代速度，不必花過多的時間來修復(fù) bug 和完善代碼。好的代碼不但能夠使得新的項目成員更容易加入項目，同時方便項目組成員快速做好 Back up。好的代碼便于促進(jìn)團(tuán)隊間交流合作提升開發(fā)效率。 代碼質(zhì)量評價標(biāo)準(zhǔn) 有編碼經(jīng)驗的人對代碼都有一定的“鑒賞力”，能夠憑感覺給出代碼好壞的主觀評價。但是這種憑感覺的方式太過個性隨意，所謂仁者見仁智者見智，很難達(dá)成共識，那有沒有一種公認(rèn)的標(biāo)準(zhǔn)來鑒定代碼質(zhì)量呢？ 答案是有的。這里簡單分享當(dāng)下較常用的評價標(biāo)準(zhǔn)，其中包括：編碼規(guī)范、可讀性、可維護(hù)性、重復(fù)度及可測試性。 主要包含是否遵守了最佳實踐和團(tuán)隊編碼規(guī)范，是否包含可能出問題的代碼，以及可能存在安全的漏洞。編碼規(guī)范有助于提高團(tuán)隊內(nèi)協(xié)助的效率以及代碼的可維護(hù)性。 Code Review 是一個很好的測驗代碼可讀性的手段。如果你的同事可以輕松地讀懂你寫的代碼，那說明你的代碼可讀性很好；反之則說明你的代碼可讀性有待提高了。遵守編碼規(guī)范也能讓我們寫出可讀性更好的代碼。 代碼的可維護(hù)性是由很多因素協(xié)同作用的結(jié)果。代碼的可讀性好、簡潔、可擴(kuò)展性好，就會使得代碼易維護(hù)；更細(xì)化地講，如果代碼分層清晰、模塊化好、高內(nèi)聚低耦合、遵從基于接口而非實現(xiàn)編程的設(shè)計原則等等，那就可能意味著代碼易維護(hù)。除此之外，代碼的易維護(hù)性還跟項目代碼量的多少、業(yè)務(wù)的復(fù)雜程度、利用到的技術(shù)的復(fù)雜程度、文檔是否全面等諸多因素有關(guān)。 遵守 Don’t Repeat Yourself 原則，盡量減少重復(fù)代碼的編寫，復(fù)用已有的代碼。對項目定期進(jìn)行代碼重復(fù)度檢測是一個很有意義的事，可以幫助開發(fā)人員發(fā)現(xiàn)冗余代碼，進(jìn)行代碼抽象和重構(gòu)。重復(fù)的代碼一旦出錯，意味著加倍的工作量和持續(xù)的不可控。如果代碼中有大量的重復(fù)代碼，就要考慮將重復(fù)的代碼提取出來，封裝成公共的方法或者組件。 代碼可測試性的好壞，同樣可以反應(yīng)代碼質(zhì)量的好壞。代碼的可測試性差，比較難寫單元測試，那基本上就能說明代碼設(shè)計得有問題。 在公眾號后端架構(gòu)師后臺回復(fù)“架構(gòu)整潔”，獲取一份驚喜禮包。 除此之外還有很多代碼質(zhì)量評價標(biāo)準(zhǔn)。我們需要一些取舍，選取部分大家有共識的規(guī)則定義團(tuán)隊好的代碼標(biāo)準(zhǔn)。 代碼質(zhì)量維度 當(dāng)前版本通過 @iceworks/doctor 從 5 個維度對代碼進(jìn)行評分： 最佳實踐： 通過 @iceworks/eslint-plugin-best-practices 分析項目，提出符合當(dāng)前工程特征（對 ice 和 Rax項目友好）的最佳實踐及阻塞問題發(fā)布卡口，幫助開發(fā)者優(yōu)化項目性能，避免潛在 bug 。
安全實踐： 通過 @iceworks/eslint-plugin-security-practices 掃碼代碼檢測工程中可能存在的安全風(fēng)險，包含 url 、敏感成詞、明文賬密信息及 npm 包證書檢測，降低項目安全風(fēng)險，守衛(wèi)項目安全。
阿里代碼規(guī)范： 這一維度主要反饋開發(fā)人員對于 eslint-config-ali 阿里開發(fā)規(guī)約的遵守程度。
可維護(hù)度： 通過 typhonjs-escomplex 對文件進(jìn)行掃碼，得出每個文件的可維護(hù)度，可讀性及復(fù)雜度評分。針對得分較差的文件可以進(jìn)行深度分析幫助開發(fā)者更好的重構(gòu)復(fù)雜代碼。
重復(fù)度： 通過 jscpd 計算重復(fù)出現(xiàn)的代碼區(qū)塊占比，計算出 clone 分?jǐn)?shù)。并逐一列舉重復(fù)的代碼，方便開發(fā)者快速定位重復(fù)代碼，將其封裝成公共的方法或者組件。
根據(jù)上述 5 個維度通過加權(quán)平均的方式計算項目質(zhì)量分，并根據(jù)木桶效應(yīng)，在計算得分的過程中加大了最低分的權(quán)重，得出最終項目質(zhì)量評分。 項目地址 github地址：github.com/ice-lab/iceworks/tree/master/
