工程開發
clean-code avatar

clean-code

實用且精簡的 AI 程式碼標準,專注於乾淨程式碼、簡潔性與可維護性。強制執行 SRP、DRY 與 KISS 等最佳實踐,避免過度設計。

簡介

Clean Code 技能為 AI 代理程式提供了一套框架,使其能撰寫簡潔、直接且以解決方案為導向的程式碼。此技能專為優先考慮長期維護性與可讀性,而非快速開發的軟體開發者與 AI 程式設計助手所設計。透過應用嚴格的編碼標準,此技能可最小化認知負荷,確保程式庫具有擴展性,並減少技術債的累積。它引導代理程式進行系統性的命名規則、模組化函數設計與現代架構模式的應用。

  • 鼓勵核心原則,包含單一職責原則 (SRP)、不重複原則 (DRY)、保持簡單 (KISS) 與你不會需要它 (YAGNI)。

  • 強制執行明確的變數、函數與常數命名慣例,確保程式碼具備自解釋性。

  • 透過限制函數大小、最小化參數數量與避免副作用來控制程式碼複雜度。

  • 提倡使用防禦性編程與早期返回取代深層嵌套邏輯,以提升可讀性與測試性。

  • 實作嚴格的編輯前檢查,要求代理程式在修改前評估相依性、影響範圍與測試覆蓋率。

  • 最適合用於 TypeScript、JavaScript 與其他現代語言專案,確保架構完整性至關重要。

  • 作為代理程式的主要準則,要求在修復錯誤時不進行冗長的解釋,保持互動簡潔高效。

  • 整合 linting、型別覆蓋率與專門的測試執行程式等驗證腳本,自動檢查程式碼品質。

  • 限制條件包含嵌套層級上限為兩層,以及每個函數建議不超過 20 行,以防出現龐大的萬能函數。

  • 使用者可預期獲得直接、功能正確的程式碼變更,並確保優先考慮代碼的清晰度與極簡的實作成本。

倉庫統計

Star 數
7,262
Fork 數
1,432
Open Issue 數
36
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月30日 下午04:06
在 GitHub 查看