程式碼審查是保持高水平程式碼質量的有效方式。程式碼審查不僅可以作為查詢問題程式碼的門檻，而且可以激勵編碼人員提高技能、學習和審查自己的工作。

現實情況是，大多數程式設計人員都沒有一個正式的程式碼審查清單。並且清單很可能是自己建立的，而並非是所有程式設計師和公司團隊統一討論設計並使用的，因此很可能存在缺陷。

為什麼要使用清單?

程式碼審查需要根據情況進行變化。如果沒有根據實際情況進行變化，那麼很可能遺漏一些重大缺陷。透過使用清單有助於評審者關注重要的內容，並在大的事情上找到變化的內容。

什麼時候應該使用程式碼審查清單?

清單可以用來改進程式碼檢查的工具，也可以是公司開發和安全團隊構建的日常習慣。無論出於哪種作用，清單都可以被提交程式碼進行編碼設查的程式設計師和安全人員使用。

準備程式碼是一個重要的步驟，審查清單可以幫助程式設計師在將程式碼交給安全人員之前更客觀地檢視他們的程式碼，同時在安全編碼方面起到提醒程式設計師的作用。

在構建程式碼審查清單時要考慮到清單長度。如果清單太短，就不可能覆蓋所有重要的事情，但如果太長，又很可能因為太乏味而遭到忽略。長度應該根據團隊規模來確定，根據經驗，一般涉及3-5個主要問題和另外7-10個較小的問題。

程式碼審查清單可能會涉及很多問題，有些問題很長，有些涉及範圍很廣，但最重要的是從基礎開始，確保涉及的主題足夠寬泛和基礎。但透過清單來確定程式碼設計的好壞是沒有意義的，反而可以透過了解編寫程式碼的原因及專案來提供新的視角來審查程式碼。

一旦理解了程式碼的作用，就應該想到：程式碼更改是否簡單有效地實現了目標?相信大家都非常保護自己的程式碼，因此不願意放棄曾經的工作去尋找其他不同的解決方案。但是如果發現更有效的程式碼更改建議，則應該讓程式設計師注意到這點。

如何在程式碼審查清單中傳達建議並且容易被接受是一項重要的事情。程式碼審查並不是為了展示優越性或者引起衝突，而是為了讓程式碼儘可能更好。

程式碼評審中一個經常被忽視的部分是依賴項。很容易忽略一個新的依賴項或包中不屬於它的程式碼。把這個專案列在清單上，可以確保沒有遺漏這個問題。這也可以使程式碼審查更快，因為任何依賴關係的問題都可以由編碼人員在提交程式碼進行審查之前解決。

清單通常都不是一成不變的，就像軟體或者其他方面的設計一樣，程式碼審查清單應該隨著時間的推移而改進。在會議議程中從每個人那裡獲得對清單改進的反饋，使其隨著程式碼庫增加而增長。

建立正確的程式碼檢查清單，需要對可用的檢查清單做一些研究，並將它們拆開。找到與公司設計相關的專案，並將它們整合在一起。

對於剛開始構建清單的團隊來說，第一次就構建完美的程式碼審查清單是不現實的。不斷找出需要審查的錯誤並新增到清單中來防止其出現，並且刪掉不會產生任何變化的專案，在審查過程中不斷最佳化清單內容，並提高軟體程式碼質量，獲得協作性更強的團隊。

文章來源：

https://blog.checkpoint.com/2022/04/08/code-review-checklist-8-steps-to-improved-productivity/