---
source: ../../../../skills/code-review-assistant/review-checklist.md
source_version: 1.0.0
translation_version: 1.0.0
last_synced: 2025-12-25
status: current
---

# 程序码审查检查清单

> **语言**: [English](../../../../skills/code-review-assistant/review-checklist.md) | 简体中文

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

---

## 目的

本文件提供全面的程序码审查检查清单，以确保程序码品质和标准合規性。

---

## 1. 功能性

- [ ] **程序码执行预期功能**
  - 已验证需求/規格对齊
  - 滿足驗收标准
  - 处理邊界情况

- [ ] **無明顯错误**
  - 存在 null/undefined 检查
  - 检查陣列邊界
  - 处理错误条件

- [ ] **邏辑正确**
  - 条件合理
  - 回圈正确終止
  - 计算准确

---

## 2. 设计与架構

- [ ] **遵循项目架構**
  - 尊重分层
  - 維持关注点分離
  - 依賴方向正确

- [ ] **使用適當的设计模式**
  - 無過度设计
  - 無设计不足
  - 正确应用模式

- [ ] **程序码放置在正确位置**
  - 文件邏辑組織
  - 相关程序码集中放置

---

## 3. 程序码品质

- [ ] **遵循编码标准**
  - 遵守命名慣例
  - 格式一致
  - 遵循样式指南

- [ ] **無程序码異味**
  - 方法 ≤50 行
  - 类别具有单一職責
  - 圈複雜度 ≤10
  - 無深层巢状条件（≤3 层）

- [ ] **应用 DRY 原則**
  - 無重複程序码區塊
  - 提取共用邏辑

---

## 4. 可读性

- [ ] **程序码易於理解**
  - 变數名称具描述性
  - 函式名称揭示意图
  - 邏辑自然流暢

- [ ] **註解有幫助**
  - 解釋複雜邏辑
  - 记录为什麼（WHY），而非什麼（WHAT）
  - 無被註解掉的程序码

---

## 5. 测试

- [ ] **存在测试**
  - 新程序码有测试
  - 测试涵蓋正常路徑
  - 测试涵蓋错误情况
  - 测试邊界情况

- [ ] **测试品质良好**
  - 测试可读
  - 测试名称描述場景
  - 斷言清晰
  - 無不穩定测试

- [ ] **維持测试覆蓋率**
  - 覆蓋率未降低
  - 涵蓋关鍵路徑

---

## 6. 安全性

- [ ] **無安全漏洞**
  - 無 SQL 注入風險
  - 無 XSS 漏洞
  - 無硬编码密鑰
  - 無不安全的依賴

- [ ] **存在输入验证**
  - 清理使用者输入
  - 执行型别检查
  - 強制执行大小限制

- [ ] **身份验证/授权正确**
  - 適當的身份验证检查
  - 強制执行基於角色的存取
  - 保護敏感数据

---

## 7. 效能

- [ ] **無明顯效能問題**
  - 無 N+1 查詢
  - 無不必要的回圈
  - 熱路徑中無阻塞操作

- [ ] **使用高效演算法**
  - 考慮複雜度
  - 適當的数据结构
  - 有益处时使用快取

- [ ] **資源管理適當**
  - 关閉連线
  - 防止记忆体洩漏
  - 釋放文件控制代码

---

## 8. 错误处理

- [ ] **適當处理错误**
  - 存在 try-catch 區塊
  - 捕獲特定例外
  - 避免通用捕獲

- [ ] **错误消息有幫助**
  - 消息具描述性
  - 包含可操作信息
  - 無暴露敏感数据

- [ ] **日誌记录充分**
  - 记录错误与上下文
  - 日誌层级適當
  - 無過度日誌记录

---

## 9. 文件

- [ ] **存在 API 文件**
  - 记录公開方法
  - 解釋參數
  - 描述回传值
  - 记录例外

- [ ] **如需要則更新 README**
  - 记录新功能
  - 更新安裝说明

- [ ] **更新 CHANGELOG（如適用）**
  - 將面向使用者的变更加入 `[Unreleased]`
  - 以 **BREAKING** 標记破壞性变更

---

## 10. 依賴

- [ ] **依賴有正當理由**
  - 新依賴必要
  - 授权相容
  - 無安全漏洞
  - 積極維護

- [ ] **依賴版本已鎖定**
  - 指定确切版本
  - 更新鎖定文件

---

## 快速參考卡

```
┌─────────────────────────────────────────┐
│ Code Review Quick Checklist            │
├─────────────────────────────────────────┤
│ ✓ Functionality - Does it work?        │
│ ✓ Design - Right architecture?         │
│ ✓ Quality - Clean code?                │
│ ✓ Readability - Easy to understand?    │
│ ✓ Tests - Adequate coverage?           │
│ ✓ Security - No vulnerabilities?       │
│ ✓ Performance - Efficient?             │
│ ✓ Errors - Properly handled?           │
│ ✓ Docs - Updated?                      │
│ ✓ Dependencies - Necessary?            │
└─────────────────────────────────────────┘
```

---

## 相关标准

- [Code Review Checklist](../../../../core/code-review-checklist.md)
- [Checkin Standards](../../../../core/checkin-standards.md)
- [Pre-Commit Checklist](./checkin-checklist.md)

---

## 版本历史

| 版本 | 日期 | 变更 |
|---------|------|---------|
| 1.0.0 | 2025-12-24 | 新增：标准章节（目的、相关标准、版本历史、授权） |

---

## 授权

本文件依 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 發布。

**來源**: [universal-dev-standards](https://github.com/AsiaOstrich/universal-dev-standards)
