高效代碼審查的十個經驗

來源:互聯網
上載者:User

 

代碼審查(Code Review)是軟體開發中常用的手段,和QA測試相比,它更容易發現和架構以及時序相關等較難發現的問題,還可以協助團隊成員提高編程技能,統一編程風格等。

1. 代碼審查要求團隊有良好的文化

團隊需要認識到代碼審查是為了提高整個團隊的能力,而不是針對個體設定的檢查“關卡”。

“A的代碼有個bug被B發現,所以A能力不行,B能力更好”,這一類的陷阱很容易被擴散從而影響團隊內部的協作,因此需要避免。

另外,代碼審查本身可以提高開發人員的能力,讓其從自身犯過的錯誤中學習,從他人的思路中學習。如果開發人員對這個流程有抵觸或者反感,這個目的就達不到。

2. 謹慎的使用審查中問題的發現率作為考評標準

在代碼審查中如果發現問題,對於問題的發現者來說這是好事,應該予以鼓勵。但對於被發現者,我們不主張使用這個方式予以懲罰。軟體開發中bug在所難免,過度苛求本身有悖常理。更糟的是,如果造成參與者怕承擔責任,不願意在審查中指出問題,代碼審查就沒有任何的價值和意義。

3. 控制每次審查的代碼數量

根據smartbear在思科所作的調查,每次審查200行-400行的代碼效果最好。每次試圖審查的代碼過多,發現問題的能力就會下降,具體的比例關係如下圖所示:

我們在實踐中發現,隨著開發平台和開發語言的不同,最優的代碼審查量有所不同。但是限制每次審查的數量確實非常必要,因為這個過程是高強度的腦力密集型活動。時間一長,代碼在審查者眼裡只是字母,無任何邏輯聯絡,自然不會有太多的產出。

4. 帶著問題去進行審查

我們在每次代碼審查中,要求審查者利用自身的經驗先思考可能會碰到的問題,然後通過審查工作驗證這些問題是否已經解決。一個竅門是,從使用者可見的功能出發,假設一個比較複雜的使用情境,在代碼閱讀中驗證這個使用情境是否能夠正確工作。

使用這個技巧,可以讓審查者有代入感,真正的沉浸入代碼中,提高效率。大家都知道看武俠小說不容易瞌睡,而看專業書容易瞌睡,原因就是武俠小說更容易產生代入感。

有的研究建議每次樹立目標,控制單位時間內審核的代碼數量。這個方法在我們的實踐中顯得很機械和流程化,不如上面的方法效果好。

5. 所有的問題和修改,必須由原作者進行確認

如果在審查中發現問題,務必由原作者進行確認。

這樣做有兩個目的:

(1)確認問題確實存在,保證問題被解決

(2)讓原作者瞭解問題和不足,協助其成長

有些時候為了追求效率,有經驗的審查者更傾向於直接修改代碼乃至重構所有代碼,但這樣不利於提高團隊效率,並且會增加因為重構引入新bug的幾率,通常情況下我們不予鼓勵。

6.利用代碼審查啟用個體“能動性"

即使項目進度比較緊張,無法完全的進行代碼審查,至少也要進行部分代碼的審查,此時隨即抽取一些關鍵區段是個不錯的辦法。

背後的邏輯是,軟體開發是非常有創造性的工作,開發人員都有強烈的自我驅動性和自我實現的要求。讓開發人員知道他寫的任何代碼都可能被其他人閱讀和審察,可以促使開發人員集中注意力,尤其是避免將品質糟糕,乃至有低級錯誤的代碼提交給同伴審查。開源軟體也很好的利用了這種心態來提高代碼品質。

7.在非正式,輕鬆的環境下進行代碼審查

如前所述,代碼審查是一個腦力密集型的工作。參與者需要在比較輕鬆的環境下進行該工作。因此,我們認為像某些實踐中建議的那樣,以會議的形式進行代碼審查效果並不好,不僅因為長時間的會議容易讓效率低下,更因為會議上可能出現的爭議和思考不利於進行如此複雜的工作。

8.提交代碼前自我審查,添加對代碼的說明

所有團隊成員在提交代碼給其他成員審查前,必須先進行一次審查。這次自我修正形式的審查除了檢查代碼的正確性以外,還可以完成如下的工作:

(1)對代碼添加註釋,說明本次修改背後的原因,方便其他人進行審查。

(2)修正編碼風格,尤其是一些關鍵資料結構和方法的命名,提高代碼的可讀性。

(3)從全域審視設計,是否完整的考慮了所有情景。在實現之前做的設計如果存在考慮不周的情況,這個階段可以很好的進行補救。

我們在實踐中發現,即使只有原作者進行代碼審查,仍然可以很好的提高代碼品質。

9.實現中記錄筆記可以很好的提高問題發現率

成員在編碼的時候應做隨手記錄,包括在代碼中用注釋的方式表示,或者記錄簡單的個人文檔,這樣做有幾個好處:

(1)避免遺漏。在編碼時將考慮到的任何問題都記錄下來,在審查階段再次檢查這些問題都確認解決。

(2)根據研究,每個人都習慣犯一些重複性的錯誤。這類問題在編碼是記錄下來,可以在審查的時候用作檢查的依據。

(3)在反覆記錄筆記並在審查中發現類似的問題後,該類問題出現率會顯著下降

10. 使用好的工具進行輕量級的代碼審查

“工欲善其事,必先利其器”。我們使用的是bitbucket提供的代碼託管服務。

每個團隊成員獨立開發功能,然後利用Pull Request的形式將代碼提交給審查者。複審者可以很方便在網頁上閱讀代碼,添加評論等,然後原作者會自動收到寄件提醒,對審閱的意見進行討論。

即使團隊成員分布在天南海北,利用bitbucket提供的工具也能很好的進行代碼審查。

原文連結:http://www.html5cn.org/article-4001-1.html



相關文章

Beyond APAC's No.1 Cloud

19.6% IaaS Market Share in Asia Pacific - Gartner IT Service report, 2018

Learn more >

Apsara Conference 2019

The Rise of Data Intelligence, September 25th - 27th, Hangzhou, China

Learn more >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。