代碼審查檢查清單 (Code Review Checklist)
使用方式: Check this code against the review checklist
當審查代碼時,請明確驗證以下重點:
1. 程式碼整潔與可讀性 (Clean Code & Readability)
- • 命名: 變數與函式名稱是否具描述性且風格一致?
- • 函式: 函式是否保持短小且遵守「單一職責原則」?
- • 註解: 對於複雜邏輯是否有寫「為什麼 (Why)」的註解?(避免僅描述「做什麼 (What)」)
- • DRY 原則: 是否有重複的程式碼應該被提取出來?
2. 型別安全 (Type Safety - TypeScript/Svelte)
- • 禁用
any: 確保使用具體的型別,避免使用any。 - • 介面定義: Props 和 State 是否有定義清楚的 Interface/Type?
- • 嚴格性: 程式碼是否通過 Null/Undefined 的嚴格檢查?
3. 效能 (Performance)
- • 重新渲染: 在 Svelte/React 元件中是否有不必要的重新渲染?
- • 迴圈: 迴圈內是否避免了昂貴的運算?
- • 延遲載入: 大型函式庫或元件是否盡可能使用了 Lazy Loading?
4. 安全性 (Security)
- • 輸入驗證: 使用者輸入是否經過驗證與消毒 (Sanitized)?
- • 敏感資料: 是否有 API Key 或機密資訊被寫死 (Hardcoded) 在代碼中?(絕對禁止)
5. 測試 (Testing)
- • 覆蓋率: 新的邏輯是否有單元測試覆蓋?
- • 邊際情況: 是否處理了 Null、空陣列或錯誤狀態等邊際情況?