程式碼審查
Code Review
什麼是程式碼審查?
- 由同事檢視程式碼,找出錯誤與改善空間
- 發現獨自看不見的錯誤
- AI 程式碼也需要審查
程式碼審查一旦成為習慣,程式碼的主人就會改變。"這是金代理寫的模組"這類說法會消失,從合併的那一刻起,整個團隊共同承擔責任的就是資產。負責人休假或離職,程式碼也不會變成無人照管。同時,發現問題的時間點也會提前。過去在故障爆發的凌晨翻查紀錄才找出的錯誤,現在只要合併前的一句提問就能抓出來。審查不是拖慢進度的程序,而是把之後才會爆發的時間,提前拿來用。
運作方式大致分為兩種。在畫面前一起看、當場來回討論的同步審查,適合結構會大幅變動的變更;在 PR 上留下意見的非同步審查,則適合日常的變更。關鍵在於單位。大小膨脹到數千行的 PR,審查者無法讀到最後,結果只會蓋上核准章,因此每個團隊最好為單一 PR 訂出大小上限,把變更切小。角色界線也要分明。縮排、命名、未使用變數等指摘交給 Linter 與靜態分析工具,人則專注於設計意圖與例外情境。確認行為是否正確是測試程式碼與 QA 的工作,不該由審查者用眼睛實際執行來確認。
現場最常出問題的地方,是「核准了卻沒讀」的狀態。審查集中在一兩位資深員工身上時,PR 會堆積好幾天;趕時間的作者說出「先合併,之後再看吧」的那一刻,審查就只剩形式。相反地,若把審查當成堅持個人喜好的場合,資淺員工會害怕提 PR,把變更攢在一起一次丟出來。AI 生成的程式碼也一樣,若只因為能跑就不讀就合併的習慣累積下來,幾個月後服務核心裡會留著沒有人能解釋其內部的程式碼。
此做法源自軟體工程的品質管理慣例,隨著 Git 與 Pull Request 的普及,已成為日常的開發文化。
以下用假設的案例來看。員工 140 人規模的電商平台 A 公司,開發人員有 22 位,光上一季就出現 14 次部署後回滾。為了趕功能上線時程,不經審查直接合併已成慣例,而付款模組實際上只有一個人清楚內容。
- 季度回顧時,CTO 指出「14 次回滾中有 8 次本可在部署前攔下」,因此決定停止不經審查的合併。
- 讓後端負責人把一件 PR 拆到 300 行以內,並設定分支保護,在 2 位審查者中至少 1 人核准之前禁止合併。
- 前兩週審查留言被規範指摘洗版,於是把 Linter 與靜態分析接進 CI,讓機器去抓可以自動判斷的部分,人只看設計與例外處理。
- 審查等待時間平均拉長到 31 小時後,我們把每天上午 10:20 固定為「審查時段」,並承諾 24 小時內會留下第一則意見。
- 禁止只寫「LGTM」一行的核准,改為要求寫下「已確認付款失敗的重試路徑」這類確認了什麼,形式上的核准明顯減少了。
- 三個月後每月回滾次數從 3.5 次降到 0.8 次,審查等待時間從 31 小時縮短到 7 小時,新進開發人員的上手期間也從 6 週縮短為 3 週。
朴雪英
金鍾赫