Code Review 六大原則

進行 Code Review 時，應考慮多個面向，包含功能邏輯、程式碼風格、效能、可維護性與易讀性、安全性、模組化與重用性，以確保程式碼品質、可讀性與長期可維護性。以下是每個面向的介紹：

1. 功能邏輯

確保程式碼的邏輯清晰、正確，並符合需求。這一部分是確認程式能夠正確執行其預期功能，檢查邊界條件（boundary conditions）、錯誤處理以及例外情況的處理，防止因邏輯錯誤導致系統運作不正常。

• boundary conditions：
  • 有無處理Null問題。
  • 輸入長度是否合理限制。

2. 程式碼風格

包括變數命名規則與程式碼的一致性。變數應具有描述性，能讓開發者容易理解其用途；風格一致性則能提升團隊合作效率，減少因不同編碼風格導致的困惑、降低溝通成本。

• 專案程式碼風格一致：
  • Variables、Functions 命名。
  • 縮排、空白符號。

3. 效能

檢查程式在處理資源時是否有效率，特別是對於大型資料集或對資料表高頻率操作，應該考慮其執行效能，以確保程式能夠在實際環境中平穩運作。

• 需要檢查
  • 是否有不必要的重複運算。
  • 使用非最佳化的資料結構。
  • 產生不必要的 I/O 操作。

4. 可維護性與易讀性

可維護性和易讀性是長期開發的關鍵。程式碼應該具備清晰的結構，並在適當的地方加上註解，幫助後續的開發者或自己在未來維護系統時能夠快速理解和修改程式。註解應該是簡潔且直接指出程式碼的目的或邏輯，避免冗長及不必要的說明。

5. 安全性

重點是確認程式是否防範了常見的安全風險，例如 SQL Injection、跨站請求偽造（CSRF）或跨站指令碼（XSS）。應檢查所有的使用者輸入是否經過適當的驗證和轉譯，避免讓惡意輸入影響系統安全性。

6. 模組化與重用性

程式碼應該具備模組化設計，這樣能夠讓功能區塊分離獨立，便於測試、維護和重用。模組化的設計讓程式更易於擴展，且可以在不同的專案中重用已驗證的模組，降低開發時間與錯誤風險。

接下來的文章將針對每一項 Code Review 原則舉例說明。
有來勢洶洶的颱風要來了，邦友趕緊囤一下泡麵！