Clean Code
目的
提升程式碼的可讀性、可維護性、可測試性和一致性，同時避免引入不必要的複雜度。
核心原則
- 使用有意義且一致的名稱。
- 讓函式專注於單一職責。
- 優先選擇簡單的解決方案，而非不必要的抽象。
- 避免重複的業務邏輯。
- 在適用的情況下遵循 SOLID 原則。
- 優先使用明確的依賴，而非隱藏的耦合。
- 清楚且一致地處理錯誤。
- 讓程式碼易於測試和維護。
工作流程
在編寫或重構程式碼時：
- 理解現有行為和需求。
- 識別具體的程式碼品質問題。
- 提出最小且合理的改進方案。
- 除非要求變更，否則保留現有功能。
- 遵循專案既有的架構和慣例。
- 在適當時機新增或更新相關測試。
- 解釋重要的變更和取捨。
重構指南
- 不要重構不相關的模組。
- 不要在沒有明確效益的情況下引入設計模式。
- 避免過早最佳化。
- 當繼承會增加不必要的耦合時，優先使用組合。
- 除非明確批准中斷性變更，否則保持公開 API 的相容性。
- 不要悄悄更改業務規則。
- 避免在沒有正當理由的情況下新增依賴。
驗證
在完成任務前：
- 檢查所需行為是否已實作。
- 審查命名、可讀性和重複性。
- 檢查錯誤處理和邊界情況。
- 在可用時執行相關測試和靜態分析。
- 回報任何無法執行的測試。
輸出期望
當建議改進時：
- 解釋已識別的問題。
- 描述提議的變更。
- 在獲得授權後實作變更。
- 解釋相關的取捨。
- 總結驗證結果。
專案適應
遵循儲存庫特定的指示和技術慣例。
除非儲存庫上下文已確認，否則不要假設專案使用特定的語言、框架、資料庫或架構。