code-review-checklist

代码审查清单

快速审查清单

正确性

• 代码实现了预期功能
• 已处理边界情况
• 已设置错误处理
• 没有明显的 Bug

安全性

• 已验证并清理输入
• 不存在 SQL/NoSQL 注入漏洞
• 不存在 XSS 或 CSRF 漏洞
• 没有硬编码的密钥或敏感凭据
• AI 特有： 已防范提示词注入（如适用）
• AI 特有： 输出在用于关键接收点之前已清理

性能

• 没有 N+1 查询
• 没有不必要的循环
• 缓存设置合理
• 已考虑对包体积的影响

代码质量

• 命名清晰
• 遵循 DRY 原则，没有重复代码
• 遵循 SOLID 原则
• 抽象层级恰当

测试

• 为新增代码编写了单元测试
• 已测试边界情况
• 测试易于阅读和维护

文档

• 已为复杂逻辑添加注释
• 已为公共 API 编写文档
• 如有需要，已更新 README

AI 与大模型审查模式

逻辑与幻觉

• 思维链： 逻辑是否遵循可验证的路径？
• 边界情况： AI 是否考虑了空状态、超时和部分故障？
• 外部状态： 代码是否对文件系统或网络做出了安全的假设？

提示词工程审查

// ❌ Vague prompt in code
const response = await ai.generate(userInput);

// ✅ Structured & Safe prompt
const response = await ai.generate({
  system: "You are a specialized parser...",
  input: sanitize(userInput),
  schema: ResponseSchema
});

需要标记的反模式

// ❌ Magic numbers
if (status === 3) { ... }

// ✅ Named constants
if (status === Status.ACTIVE) { ... }

// ❌ Deep nesting
if (a) { if (b) { if (c) { ... } } }

// ✅ Early returns
if (!a) return;
if (!b) return;
if (!c) return;
// do work

// ❌ Long functions (100+ lines)
// ✅ Small, focused functions

// ❌ any type
const data: any = ...

// ✅ Proper types
const data: UserData = ...

审查评论指南

// Blocking issues use 🔴
🔴 BLOCKING: SQL injection vulnerability here

// Important suggestions use 🟡
🟡 SUGGESTION: Consider using useMemo for performance

// Minor nits use 🟢
🟢 NIT: Prefer const over let for immutable variable

// Questions use ❓
❓ QUESTION: What happens if user is null here?