如何進(jìn)行代碼審查？代碼審查工具都有哪些？

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

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

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

1. 單獨(dú)提交代碼清理命令（重新格式化或修復(fù)拼寫錯(cuò)誤等）和重構(gòu)。

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

2. 編寫相關(guān)的提交說(shuō)明

務(wù)必確保你的提交注釋可以很好地向?qū)彶檎哒f(shuō)明提交的內(nèi)容，還有尤其要說(shuō)明代碼變更的原因。如果你的設(shè)計(jì)受到了很大限制，也一定要寫好說(shuō)明。

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

3. 只提交準(zhǔn)備好審查的代碼

因此，請(qǐng)確保你的代碼通過(guò)了所有測(cè)試。另外，在讓別人審查你的代碼前，先進(jìn)行自我審查，仔細(xì)看看你提交的代碼差異。

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

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

回顧被審查者的工作，我們可以得出一個(gè)結(jié)論，即不要給審查者制造不必要的麻煩當(dāng)屬代碼審查過(guò)程中被審查者的最佳行為準(zhǔn)則：

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

代碼審查工具輔助審查

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

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

推薦閱讀：

超實(shí)用的代碼質(zhì)量審核和管理工具CodeAnalyzer

我們?yōu)槭裁匆褂渺o態(tài)代碼掃描工具？常用靜態(tài)代碼掃描工具對(duì)比

如何寫出具有商業(yè)意義的高質(zhì)量代碼？

如何達(dá)成高質(zhì)量的代碼？有什么好用的代碼掃描工具嗎？

靜態(tài)分析和代碼審查：一文搞懂靜態(tài)代碼分析

如何評(píng)估軟件代碼的質(zhì)量？代碼掃描工具有哪些？

提高代碼質(zhì)量之使用合適的代碼審查工具

關(guān)于靜態(tài)代碼掃描工具CodeAnalyzer，你了解多少？