Code Review 經驗談

February 12, 2021

這一篇是結合至目前為止的工作經驗,將經驗過的好 Code Review 習慣記錄下來,並附上相關連結,以便未來 Code Review 時能夠盡可能改善專案品質。

經驗談

  1. (由主管發起) 指定小型的作業練習,並在作業完成以後,檢視程式風格與商業邏輯。這個方法的目標是告知新進人員如何配合現有專案的 Coding Style,並瞭解特定商業邏輯的運作,以及需要注意的眉角。經過大約一個月後,新進人員不太再犯寫出不符合現有專案規範的程式碼。
  2. (由我發起) 檢查版控系統中提交的 Change List,並告知提交者的 Coding Style 和討論是否有辦法寫得更好。

這兩個經驗的共通點,都是提高專案程式碼的品質,減少出現不一致寫法 (命名) 的狀況。過程中不指責對方程式碼的邏輯,因此能持續的改進提交的程式碼品質。

實用的連結

以下這些連結描述了多個 Code Review 的經驗與做法,對如何改善專案品質有很大幫助。