執行標準化程式碼審查流程,依序檢查程式碼品質、安全性、可維護性,並產出結構化的審查報告
代码审查流程(Code Review)
功能概述
代码审查流程(Code Review)是一项面向实际任务的技能,主要用于当使用者要求审查代码、Pull Request 或提交记录时,启动此审查流程;
核心要点
- Step 1:获取代码;
- 使用 exec 工具或 git-read 工具获取待审查的代码内容;
- 若使用者提供的是 PR URL,需先获取 diff;
使用与执行
Step 2:依次执行四个审查维度;维度 A:代码质量;命名是否清晰(变量、函数、类名称);函数是否符合单一职责原则等。该流程将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
结果检查与注意事项
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
程式碼審查流程(Code Review)
觸發時機
當使用者要求審查程式碼、Pull Request 或提交記錄時,啟動此審查流程。
審查步驟
Step 1:取得程式碼
使用 exec 工具或 git-read 工具取得要審查的程式碼內容。若使用者提供的是 PR URL,需先取得 diff。
Step 2:依序執行四個審查維度
維度 A:程式碼品質
- 命名是否清晰(變數、函數、類別名稱)
- 函數是否符合單一職責原則(SRP)
- 是否有明顯的重複代碼(DRY 原則)
- 複雜度是否合理(循環複雜度 ≤ 10)
維度 B:安全性
- 輸入驗證是否完整
- 是否有 SQL Injection、XSS 等常見漏洞風險
- 敏感資訊(API Key、密碼)是否未被 hardcode
維度 C:可維護性
- 是否有足夠的註解(複雜邏輯必須有說明)
- 單元測試覆蓋率是否足夠(核心邏輯 ≥ 80%)
- 錯誤處理是否完整
維度 D:效能
- 是否有明顯的 N+1 查詢問題
- 是否有不必要的重複計算
Step 3:產出審查報告
使用以下格式輸出:
## 程式碼審查報告 **審查對象:** [檔案名稱或 PR 標題] **審查日期:** [今天日期] **整體評級:** [A/B/C/D] ### 問題清單 | 嚴重度 | 維度 | 位置 | 問題描述 | 建議修改 | |--------|------|------|----------|----------| | 🔴 高 | 安全 | line 42 | ... | ... | | 🟡 中 | 品質 | line 67 | ... | ... | ### 優點記錄 - [列出 1~3 個值得肯定的設計決策] ### 總結建議 [2~3 句總結,說明最值得優先處理的問題]
重要原則
- 發現問題要具體說明位置(行號或函數名稱)
- 每個問題必須附上建議的修改方向
- 評級標準:A(無重大問題)、B(有中等問題需修改)、C(有高嚴重度問題)、D(需重大重構)
- 不做商業邏輯的合理性判斷,只評估技術品質
热门AI工具
相关专题
本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
本专题梳理XORM框架的入门路径,从框架定位、依赖安装、连接数据库到跑通第一个增删改查示例,讲清Engine初始化、日志开启与项目目录规划,并对比GORM等同类ORM的差异,帮助Go开发者建立整体认知。
0
2026.11.04
本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。
0
2026.11.03
想使用Docker Desktop将本地项目构建成Docker镜像?本专题围绕镜像构建的实际操作展开,介绍Dockerfile编写、构建命令使用、镜像标签设置和构建日志查看等内容,同时整理镜像无法生成、依赖安装失败及构建缓存异常等问题的排查思路。
0
2026.11.03
本专题聚焦Docker Desktop容器创建与运行配置,介绍通过本地镜像或远程镜像创建容器的方法,以及容器启动、终端访问、日志查看和基础管理等操作。针对端口冲突、参数配置不当、容器无法启动等情况,也整理了相应的排查方向。
0
2026.11.03
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.7万人学习
共6课时 | 54.7万人学习