code-review

Polar Sponsor
爱发电 赞助
.NET 9.0

聚焦于范围蔓延、冗余代码和逻辑缺陷,对代码变更进行审查。当用户提出代码审查(code review)、Pull Request 审查(PR review)、差异审查(diff review),或明确要求仅审查已变更代码(已变更代码 / changed code only / delta review)时使用。

Code Review

功能概述

Code Review是一项面向实际任务的技能,主要用于触发与范围;仅变更代码模式 (用户明确说「只 review 已变更代码」「仅看 diff」「changed code only」等):;

核心要点

  • 仅对当前已变更的代码进行 review;
  • 不评价未改动的文件、函数或行;
  • 需要上下文时,只读足够理解变更意图的最小范围,结论仍只针对 diff 中的行;

使用与执行

全量模式 (用户未限定范围):可按模块或文件 review,但仍优先关注本次改动。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。

结果检查与注意事项

实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。

Code Review

触发与范围

仅变更代码模式(用户明确说「只 review 已变更代码」「仅看 diff」「changed code only」等):

  • 仅对当前已变更的代码进行 review
  • 不评价未改动的文件、函数或行
  • 需要上下文时,只读足够理解变更意图的最小范围,结论仍只针对 diff 中的行

全量模式(用户未限定范围):可按模块或文件 review,但仍优先关注本次改动。

工作流

1. 收集变更

并行执行,确定 review 边界:

git status
git diff
git diff --staged

若存在 base 分支,补充:

git diff ...HEAD

记录:变更文件列表、每个 hunk 的增删改、用户描述的需求/任务目标。

2. 理解需求边界

在 review 前明确:

  • 用户/任务要求改什么
  • 哪些文件/逻辑理论上不应动

后续所有结论都对照这条边界判断。

3. 执行三项核心检查

按优先级审查 diff 中的每一处变更:

A. 需求外影响(最高优先级)

着重检查变更后的代码有没有影响需求以外的内容,防止无意修改无关代码或者破坏不应该修改的逻辑。

具体检查:

  • 改动是否超出任务描述(顺手重构、格式化整文件、改命名/注释/导入等无关项)
  • 是否修改了不应触碰的模块、公共 API、配置、鉴权、错误处理契约
  • 删除/替换代码是否破坏原有调用方、分支、降级或兼容逻辑
  • 变更是否引入行为回归(原功能静默失效、条件变宽/变窄、默认值变化)
  • 测试/配置/文档的改动是否与需求一致,还是附带修改

疑似越界时:标出具体 hunk,说明「需求内应有 / 实际做了什么 / 风险」。

B. 冗余

检查已变更代码是否有冗余的部分:

  • 重复逻辑、可合并的分支、无意义的中间变量或包装
  • 未使用的导入、变量、函数、死代码
  • 与现有工具函数/组件重复的实现
  • 过度防御或重复的校验、日志、注释块
  • 可用更小 diff 达成同样目标的写法

C. 逻辑漏洞

检查变更代码有没有逻辑漏洞:

  • 边界条件:空值、空集合、0、越界、并发、超时、重试
  • 条件与分支:遗漏 else、早返回、竞态、状态不同步
  • 错误处理:吞异常、错误传播断裂、部分失败未回滚
  • 数据流:类型不匹配、隐式转换、off-by-one、单位/时区错误
  • 安全:注入、权限绕过、敏感信息泄露
  • 与调用方/被调用方契约是否一致

4. 输出报告

使用以下模板,每条发现必须引用具体变更位置(文件 + 行号或 diff hunk):

# Code Review — [范围: 仅变更代码 | 全量]

## 变更概览
- 需求/目标:[一句话]
- 变更文件:N 个
- 总体结论:[通过 | 需修改 | 阻塞]

## 发现

### 🔴 阻塞(必须修复)
1. **[类别: 需求外影响 | 冗余 | 逻辑漏洞]** `path:line`
   - 问题:
   - 风险:
   - 建议:

### 🟡 建议(建议修复)
...

### 🟢 可选优化
...

## 范围确认
- 疑似超出需求的改动:[无 / 列出]
- 未发现问题但需人工确认的点:[无 / 列出]

5. 行为约束

  • 没有 diff 时:先获取变更,或请用户指定 commit/分支/文件,不凭空 review
  • 只读 review:默认不修改代码,除非用户要求修复
  • 不扩大范围:仅变更代码模式下,不对未改动代码提「顺便可以改」类建议,除非与本次 bug 直接相关
  • 结论要有依据:每条发现对应 diff 中的具体变更,避免泛泛而谈

快速检查清单

- [ ] 已用 git diff 界定变更范围
- [ ] 已明确需求边界
- [ ] 已检查:需求外影响 / 无意破坏不应修改的逻辑
- [ ] 已检查:变更冗余
- [ ] 已检查:逻辑漏洞与边界条件
- [ ] 每条结论有文件/行号引用

示例

见 examples.md

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

0

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

0

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

0

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

0

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

0

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

0

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

0

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

0

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习