code-review-checklist

代码审查清单 | Code Review Checklist

技能概述

一套系统化的代码审查清单，帮助开发者全面检查代码的功能性、安全性、性能和可维护性，确保代码质量和团队规范一致性。

适用场景

1. Pull Request 审查

在审查同事提交的 PR 时，使用本技能可快速定位潜在问题，从功能正确性、安全漏洞、性能瓶颈到代码风格，逐一检查，确保合并的代码质量达标。

2. 代码审计与质量评估

进行代码库审计或重构前的质量评估时，本技能提供全面的检查维度，帮助识别技术债务、安全隐患和需要改进的代码区域。

3. 团队代码规范建设

为新团队建立代码审查标准，或培训新人掌握代码审查方法，本技能提供结构化的审查框架和最佳实践，提升团队整体代码质量意识。

核心功能

1. 多维度代码检查

涵盖功能性、安全性、性能、代码质量、测试覆盖、文档完整性、Git 提交规范等 8 大维度，每个维度提供详细的检查项和正反代码示例，确保审查不留死角。

2. 安全漏洞专项检查

针对 OWASP Top 10 安全风险，提供 SQL 注入、XSS、CSRF、敏感数据泄露等常见漏洞的识别方法，帮助审查者快速发现安全隐患。

3. 审查模板与最佳实践

提供完整的审查清单模板、评审意见写作模板、常见问题解决方案，以及 Google 等大厂的代码审查指南参考，让代码审查更加规范和高效。

常见问题

代码审查应该检查哪些内容？

代码审查应涵盖功能正确性、安全性、性能、代码质量、测试覆盖、文档更新等多个维度。具体包括：代码是否解决既定问题、边界情况处理、输入验证、SQL 注入等安全风险、数据库查询效率、代码可读性、测试覆盖是否充分等。本技能提供完整的分步检查清单，确保不遗漏重要环节。

如何进行高效的代码审查？

建议遵循以下原则：保持 PR 规模适中以便深入审查；先看测试是否通过并覆盖新代码；有疑问及时沟通而非主观臆断；关注重要问题而非纠结于风格细节；使用自动化工具（linter、安全扫描）辅助；审查时考虑代码对整体系统的影响。本技能包含审查前准备、审查中和审查后的完整流程指导。

代码审查常见的安全问题有哪些？

最常见的安全问题包括：SQL 注入漏洞（未使用参数化查询）、XSS 跨站脚本攻击（未转义用户输出）、硬编码的敏感信息（API 密钥、密码）、不正确的认证授权逻辑、缺少输入验证等。本技能的安全审查模块提供每种漏洞的正反代码示例，帮助快速识别和修复安全问题。