1988 年，惠普公司(HP)對其軟件開發(fā)流程進行了一次內(nèi)部審查，并為自己設(shè)定了將代碼質(zhì)量提高十倍的目標(biāo)。為了實現(xiàn)這一宏偉目標(biāo)，公司嘗試了多種方法。最后，惠普發(fā)現(xiàn)，將代碼修訂納入開發(fā)周期，比客戶發(fā)現(xiàn)漏洞后再進行修復(fù)，能節(jié)省更多資金。

可以說，惠普在這樣做的時候，軟件開發(fā)實踐還不像今天這樣明確和成熟。不過，各組織早已明白，將代碼審查納入軟件開發(fā)生命周期可以產(chǎn)生積極的效果。本文就講述了CS專業(yè)留學(xué)生審查代碼的一些技巧。

1.創(chuàng)建代碼審查清單

代碼審查核對表是一套預(yù)先定義的問題和規(guī)則，團隊在代碼審查過程中將遵循這些問題和規(guī)則，從而為代碼庫批準(zhǔn)代碼前所需的質(zhì)量控制提供結(jié)構(gòu)化方法的優(yōu)勢。檢查表可包括;

可讀性：代碼是否包含不必要的注釋?

安全性：代碼是否會使系統(tǒng)受到網(wǎng)絡(luò)攻擊?

測試覆蓋率：是否有多個測試用例需要測試?

架構(gòu)：代碼是否使用封裝和模塊化來實現(xiàn)關(guān)注點分離?

重復(fù)使用：代碼是否使用了可重復(fù)使用的組件、函數(shù)和服務(wù)?

2.引入代碼審查指標(biāo)

不衡量代碼質(zhì)量，就無法解決代碼質(zhì)量問題?？陀^的衡量標(biāo)準(zhǔn)有助于確定審查的有效性、分析流程變更的影響以及預(yù)測完成項目所需的小時數(shù)。

一些最常用的評審指標(biāo)包括;

檢查率：團隊審查特定數(shù)量代碼的比率，計算方法是用代碼行(LoC)除以檢查小時數(shù)。如果審查代碼的時間過長，則可能存在需要解決的可讀性問題。

缺陷率： 發(fā)現(xiàn)缺陷的頻率，計算方法是用缺陷計數(shù)除以檢查時間。這一指標(biāo)有助于確定測試程序的有效性;例如，如果程序員發(fā)現(xiàn)缺陷的速度很慢，你可能需要更好的測試工具。

缺陷密度： 你在特定數(shù)量的代碼中發(fā)現(xiàn)的缺陷數(shù)量，計算方法是將缺陷數(shù)量除以數(shù)千行代碼(kLOC)。缺陷密度可幫助你確定哪些組件比其他組件更容易出現(xiàn)缺陷，從而為易出現(xiàn)缺陷的組件分配更多資源。例如，如果你的一個網(wǎng)絡(luò)應(yīng)用程序比同一項目中的其他程序有更多缺陷，你可能需要為其分配更有經(jīng)驗的程序員。

3.確保你的反饋證明你的立場合理

審核代碼時，不要只建議需要修復(fù)或改進的地方，還要解釋開發(fā)人員為什么要進行修改。

在開發(fā)過程中，你經(jīng)常會遇到有多種解決方案的問題。你對代碼的評論是你的知識和經(jīng)驗的結(jié)晶;你可能更喜歡用一種特定的方法來解決問題，而這種方法可能與代碼編寫者的方法不同。因此，你應(yīng)該明確說明你的編碼選擇，以解釋你的理由。

例如，假設(shè)你正在考慮一段代碼，你認(rèn)為沒有必要使用多線程。與其簡單地勸阻開發(fā)人員不要使用線程，不如解釋說并行模型在他們的方案中并不能提供性能優(yōu)勢，因此他們應(yīng)該將代碼改為單線程。

這種方法有兩個優(yōu)點。首先，代碼的作者會知道為什么需要進行特定的修改，這將有助于他今后解決類似的問題。其次，由于他已經(jīng)說明了他的注釋的合理性，他就不必再要求說明他的注釋的合理性，從而節(jié)省了你們雙方的時間。

4.每次審查不要超過 200-400 行代碼

檢查超過 400 行代碼會對你發(fā)現(xiàn)錯誤的能力產(chǎn)生負(fù)面影響，事實上，大多數(shù)錯誤都會在前 200 行中發(fā)現(xiàn)。思科(Cisco)在其代碼審查綜合研究中發(fā)現(xiàn)了這一限制，并對行業(yè)實踐產(chǎn)生了影響。研究發(fā)現(xiàn)，當(dāng)開發(fā)人員審查的代碼超過 200 行時，發(fā)現(xiàn)錯誤的能力就會下降。

5.通過應(yīng)用程序保持最佳實踐

如果你使用 Bitbucket 作為 Git 解決方案，那么請使用 Workzone 這樣的應(yīng)用程序來簡化你的源代碼管理 (SCM) 工作流程，它可以幫助你計劃如何以及何時推送變更，如何在新的拉取請求中添加審核員和組。你還可以在池請求的源代碼和分支中設(shè)置預(yù)定義的組和審閱者，這樣它們就會默認(rèn)包含在新的池請求中。這樣，人們就能以簡單方便的方式實施 SCM 流程。

另一個能幫助實現(xiàn)代碼審查自動化的 Bitbucket 應(yīng)用程序是 Bitbucket 的 Code Owners。該工具允許你使用代碼所有者的概念來確定哪些用戶應(yīng)審查拉取請求。代碼所有者是指在特定編碼領(lǐng)域(如在 Spring Boot 中開發(fā)應(yīng)用程序)擁有知識和經(jīng)驗的人。使用代碼所有者可確保由正確的開發(fā)人員審查代碼并進行合并驗證。

海馬課堂留學(xué)生作業(yè)輔導(dǎo)，根據(jù)學(xué)生的輔導(dǎo)需求匹配背景相符的專業(yè)老師，承諾導(dǎo)師真實教育背景。1V1個性化備課，雙語教學(xué)，實時輔導(dǎo)，講解相關(guān)知識點和解題思路，提供大型作業(yè)任務(wù)的解決方案，輔導(dǎo)計算機編程語言操作，教授學(xué)生高效完成PPT和演講稿，針對性解決留學(xué)生各類作業(yè)中遇到的困擾，提高作業(yè)成績!輔導(dǎo)不滿意隨心退!