Code Review 五問五答

二胡嘈子發表於2016-04-04
View

Code Review 是什麼？

Code Review即程式碼審查，程式猿相互稽核對方的程式碼。

Code Review能獲得什麼好處？

  • 提高程式碼可維護性
    • 你寫的程式碼不再只有編譯器看了，你得寫出稽核人能看得下去的程式碼，
      並且還得考慮這段程式碼還有沒有改進或者重構的可能
  • 提高程式碼質量
    • 不再有明顯的邏輯錯誤，單元測試用例是否考慮邊界值等情況，從而減少BUG的產生
  • 團隊知識共享
    • 新的技術或者新的思路能夠快速的在團隊內傳遞
  • 提高專案預估準確性
    • 通過程式碼稽核，讓產品經理或者Scrum Master能更好的瞭解任務，更準確的估算工時
  • 業務或功能不再只依賴個人
    • 沒有人喜歡修改別人的程式碼，尤其是生產環境中的核心業務程式碼。程式碼審查可以讓至少另一個人對這段程式碼如數家珍
  • 指導新工程師
    • 程式碼審查有助於促進新成員更快的加入團隊，快速掌握業務和技術知識

提交Code Review之前要做什麼？

  • 準備或者提交相關需求文件以備審查者詢問
  • 編寫符合規範的程式碼和合適的註釋
  • 考慮程式碼是否有重構的可能
  • 單元測試全部通過，測試覆蓋率達標

如何Code Review？

  • 瞭解需求：這個提交是為了解決什麼問題，是需求單、BUG修復、還是程式碼重構，
    如果不明確，需要及時和程式碼作者溝通和討論
  • 檢查程式碼業務邏輯是否符合需求
  • 程式碼是否符合相關程式碼規範
  • 確認是否有更好的方式方法重構程式碼
  • 檢查單元測試用例是否考慮全面
  • 如果程式碼沒有問題，也寫上類似GOOD JOB之類的評論

Code Review之後可以做什麼？

  • 對於程式碼審查人表示感謝
  • 如果程式碼審查沒有通過，不要往心裡去，審查的是程式碼，不是你
  • 嘗試對每一個評論做出回覆
  • 等待合併分支，等待持續整合告訴你全部通過

參考連結

相關文章