Code Review (程式碼審查,以下簡稱審查,負責審查的人稱作審查者)是軟體團隊開發時的一個重要環節。我們團隊希望能在這件事上做得更為精進,因此選擇研讀 Google 公開的程式碼審查指南,此系列除了將原文翻譯為中文之外,也紀錄我們研讀的內容以及相關討論。翻譯後的文章共有七篇,此頁除了作為文章索引之外,同時也整理了各篇文章的精華摘要,供讀者快速查看程式碼審查的不同面向所需注意之事項。
基本原則
跟 Google 學如何 Code Review - (1) 基本原則
- 程式碼審查的最主要目的是:提升程式碼的品質。
- 審核標準:正確完成功能規格,且程式碼品質沒有降低。
- 程式碼審查也是知識轉移/形成共識的過程。審查過程中如果能討論出新的共識,則應該記錄在知識庫中,變成組織內的共享知識。
- 事實及數據為主,個人偏好次之。
- 務必遵守 style guide 。
- 大體上如果開發者可以證明設計是可以符合功能需求及兼顧可維護性等,則以開發者選擇為準。
- 維持程式碼的一致性。
- 遭遇意見衝突時,試著找出雙方都可以接受的解決方式。討論後務必做出決議,不要讓問題掛在那邊沒人處理。
審查時該看什麼
跟 Google 學如何 Code Review - (2) Code Review 時要看什麼
- 程式碼變更的整體設計
- 功能是否有達到預期目標
- 沒有不必要的複雜度、不過度設計
- 包含測試
- 容易理解的命名:明確的表達他是什麼、或他是做什麼用的
- 註解應該是表達一段程式碼的目的、如何使用該代碼以及該程式碼在使用時的行為。
- 遵守 style guide