如何進行代碼審查？代碼審查工具都有哪些？

發(fā)布時間：2020-06-23

在工作中，我們都要進行代碼審查。每個人都知道代碼審查，每個人都會做代碼審查。代碼審查的目標，其中，除了找出被審查代碼中的質量這一主要目標外，通過執(zhí)行這些審查還可以實現(xiàn)：提高代碼質量；保持項目的一致性；發(fā)現(xiàn) bug；通過他方查找代碼中的小錯誤，防止這些小錯誤日積月累腐蝕代碼等等。

代碼審查工具

代碼審查是一種好方法，它可以保持軟件的可維護性，并在軟件投入生產之前發(fā)現(xiàn) bug。

由此，軟件測試小編總結了以下幾條代碼審查的最佳方式：

1. 單獨提交代碼清理命令（重新格式化或修復拼寫錯誤等）和重構。

不建議將重新格式化與重構混合到一起。如果你想重構代碼，那么請注意用正確的格式。如果代碼中只有與重構相關的變更，那么代碼審查會容易得多。當代碼中出現(xiàn)大量基本上只是清理命令的變更時，我們有時很容易忽略小的變化。

2. 編寫相關的提交說明

務必確保你的提交注釋可以很好地向審查者說明提交的內容，還有尤其要說明代碼變更的原因。如果你的設計受到了很大限制，也一定要寫好說明。

提交說明中如果漏掉了什么重要的信息總是令人惱火，相反，清晰明了的提交注釋也會令人心情愉悅。通常在審核代碼遇到問題時，就可以試著看能否從提交注釋中找到答案。

3. 只提交準備好審查的代碼

因此，請確保你的代碼通過了所有測試。另外，在讓別人審查你的代碼前，先進行自我審查，仔細看看你提交的代碼差異。

4. 審查期間不要更改代碼

這種做法會給審查者帶來更多壓力，以致中斷審查進度。如果你想修改審查過程中發(fā)現(xiàn)的問題，那么請確保在接受審查的代碼基礎上再另建一份提交。如此一來，審查者就可以在現(xiàn)階段審查完成后，再來看你新修改的代碼。最終，在所有審批都確認后，你可以將所有的提交壓縮成一個。

回顧被審查者的工作，我們可以得出一個結論，即不要給審查者制造不必要的麻煩當屬代碼審查過程中被審查者的最佳行為準則：

確保你的代碼通過了自己的審查，并且你沒有發(fā)現(xiàn)任何明顯的問題，可以放心地合并代碼（如果你發(fā)現(xiàn)了問題，并想討論某些內容，那么提前跟你的審核者打招呼）；代碼中沒有混合不相干的變更，不會太長也不會增加閱讀難度；針對代碼變更寫好提交注釋，明確交待變更的目的。

代碼審查工具輔助審查

我們把我們個人最喜歡的東西保存到最后，因為可以說沒有比基于軟件的代碼審查工具更簡單、更有效的方式來審查代碼了，軟件工具解決了上述方法的許多局限性，以清晰一致的順序跟蹤同事的評論和缺陷的建議解決方案，使得評論能夠異步和非本地進行，當新的評論出現(xiàn)時，向原始編碼人員發(fā)出通知，并保持整個過程高效運行，無需召開會議，也無需任何人離開辦公桌。一些工具還允許審查和修訂需求文檔，重要的是，還可以生成關鍵使用統(tǒng)計數(shù)據(jù)，提供流程改進和合規(guī)性報告所需的審計試驗和審查指標。

CodeAnalyzer（簡稱CA)是上海澤眾軟件科技有限公司自主研發(fā)的專業(yè)代碼質量管理的代碼審查軟件，用于實現(xiàn)靜態(tài)分析、代碼走查、代碼規(guī)范檢查以及代碼潛在錯誤分析的白盒測試工具，它是一種脫離編譯器的代碼靜態(tài)分析軟件產品。