关于 reviewing-code
这是一项用于代码审查、反馈和质量检查的技能,覆盖正确性、可维护性、性能、TypeScript 类型安全和测试。它按严重程度整理可执行的问题,并要求指出位置、说明影响和建议修复方式。
主要功能
- 01正确性与边界情况检查
- 02可维护性审查
- 03性能检查
- 04TypeScript 类型安全审查
- 05测试覆盖检查
- 06按严重程度组织反馈
适用场景
- 01审查功能或缺陷修复
- 02检查异步错误处理
- 03评估变更代码的测试
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ spencerpauly/ awesome-cursor-skills --skill reviewing-code安装后在 Claude Code 中输入/reviewing-code确认已加载。
详细介绍
代码审查
当用户要求进行代码审查、提供代码反馈或检查代码质量时,使用此技能。
步骤
-
了解变更 — 阅读文件或差异,了解代码的预期功能。确定变更范围(新功能、错误修复或重构)。
-
检查正确性
- 代码是否处理了边界情况(空输入、null、零、负数)?
- 是否处理了错误状态(try/catch、错误边界、备用 UI)?
- 异步代码是否处理了竞态条件、取消和超时?
- 循环或数组访问中是否存在差一错误?
-
检查可维护性
- 函数是否各司其职?
- 变量和函数名称是否具有描述性?
- 是否存在可以提取的不必要重复代码?
- 是否用具名常量替代了魔法数字?
- 代码复杂度是否合理(条件嵌套过深、函数过长)?
-
检查性能
- 数据库访问中是否存在 N+1 查询模式?
- 是否在渲染循环中执行了高开销计算或 API 调用?
- 大型列表是否缺少虚拟化或分页?
- 常见数据库查询是否缺少索引?
- 是否恰当地使用了记忆化(没有过度使用)?
-
检查类型安全(TypeScript 项目)
- 是否有应进一步收窄的
any类型? - 公共 API 的函数返回类型是否明确?
- 是否穷尽处理了联合类型?
- 是否有应进一步收窄的
-
检查测试
- 是否为新增或修改的代码编写了测试?
- 测试是否覆盖了正常情况和错误情况?
- 测试是否彼此隔离(没有共享的可变状态)?
-
提供反馈 — 按严重程度整理发现:
- 必须修复:错误、安全问题、数据丢失风险
- 应该修复:性能问题、可维护性问题
- 小建议:风格偏好、轻微建议
对于每项发现,请提供文件、行号、问题和建议的修复方法。
注意事项
- 提供建设性意见——说明问题的原因,而不只是指出问题。
- 除了需要改进之处,也要肯定做得好的地方。
- 不要在风格问题上吹毛求疵;这类问题应由 linter 或格式化工具处理。
评论
支持 Markdown