code-review-assistant

程式碼審查助理

語言: English | 繁體中文

版本: 1.0.0 最後更新: 2025-12-24 適用範圍: Claude Code Skills

目的

此技能提供系統化的程式碼審查和提交前驗證檢查清單。

快速參考

註解前綴

審查檢查清單類別

1. 功能性 - 是否正常運作？
2. 設計 - 架構是否正確？
3. 品質 - 程式碼是否乾淨？
4. 可讀性 - 是否容易理解？
5. 測試 - 涵蓋率是否足夠？
6. 安全性 - 是否有漏洞？
7. 效能 - 是否高效？
8. 錯誤處理 - 是否妥善處理？
9. 文件 - 是否更新？
10. 依賴項 - 是否必要？

提交前檢查清單

• 建置成功（零錯誤、零警告）
• 所有測試通過
• 程式碼符合專案標準
• 無安全漏洞
• 文件已更新
• 分支已與目標同步

詳細指南

完整標準請參閱：

• 審查檢查清單
• 提交前檢查清單

審查註解範例

❗ BLOCKING: 此處有潛在的 SQL injection 漏洞。
請使用參數化查詢而非字串串接。

⚠️ IMPORTANT: 此方法做太多事情了（120 行）。
考慮將驗證邏輯提取到獨立方法。

💡 SUGGESTION: 考慮在此使用 Map 而非陣列以達到 O(1) 查找。

❓ QUESTION: 為什麼這裡使用 setTimeout 而不是 async/await？

📝 NOTE: 這是個聰明的解決方案！很好地運用了 reduce。

核心原則

1. 保持尊重 - 審查程式碼，而非審查人
2. 保持徹底 - 檢查功能性，而非僅檢查語法
3. 保持及時 - 在 24 小時內完成審查
4. 保持清晰 - 解釋「為什麼」，而非僅「是什麼」

配置偵測

此技能支援專案特定配置。

偵測順序

1. 檢查 CONTRIBUTING.md 的「Disabled Skills」區段
   • 如果此技能被列出，則在此專案中停用
2. 檢查 CONTRIBUTING.md 的「Code Review Language」區段
3. 若未找到，預設使用英文

首次設定

如果未找到配置且情境不明確：

1. 詢問使用者：「此專案尚未配置程式碼審查語言。您想使用哪個選項？（English / 中文）」
2. 使用者選擇後，建議在 CONTRIBUTING.md 中記錄：

## Code Review Language

This project uses **[chosen option]** for code review comments.
<!-- Options: English | 中文 -->

配置範例

在專案的 CONTRIBUTING.md 中：

## Code Review Language

This project uses **English** for code review comments.
<!-- Options: English | 中文 -->

### Comment Prefixes
BLOCKING, IMPORTANT, SUGGESTION, QUESTION, NOTE

相關標準

• Code Review Checklist
• Checkin Standards
• Testing Standards

版本歷史

授權

此技能依據 CC BY 4.0 授權釋出。

來源: universal-dev-standards