Code Review

代码审查技能。对提交的代码进行结构化检查,输出评审意见。适用于后端工程师、前端工程师提交 MR 前的自检,以及互相 Review 他人代码。包含逻辑正确性、异常处理、安全性、性能、可读性等维度。

rowankid 259f6c6 1.4 KB Updated

File contents

Code Review Skill — 代码审查技能

通用检查维度

逻辑正确性

  • 核心业务逻辑是否正确?
  • 边界条件是否处理?(空值、最大值、并发场景)
  • 返回值是否符合接口契约?

异常处理

  • 外部调用(数据库/HTTP/文件)是否有 try-catch?
  • 异常是否有意义地记录到日志?
  • 是否有兜底逻辑?

安全性

  • SQL 是否使用参数化查询?
  • 是否有越权风险?
  • 敏感信息是否避免打印到日志?

性能

  • 是否存在 N+1 查询?
  • 循环内是否有数据库 / 网络调用?
  • 大数据量场景是否有分页?

可读性

  • 函数 / 变量命名是否清晰?
  • 关键逻辑是否有注释?
  • 函数长度是否合理(< 50 行建议)?

输出模板

# 代码审查意见 — [MR/PR 标题]

审查人: | 日期: | 结论: [通过 / 修改后通过 / 打回]

## 必须修改
| 位置(文件:行号) | 问题描述 | 修改建议 |
|-----------------|---------|---------|

## 建议优化
-

## 做得好的地方
-

rowankid/ai-team/tree/main/skills/code-review commit 259f6c673e

Frequently asked questions

npx skillmds@latest add rowankid/code-review