AI 代码审查与重构建议工具——这是 Sourcery 最主要的用途,也是本文讨论的前提。

用 AI 最容易犯的错是「看着不错就用了」,这篇给出一张可复用的打分表。

评分表(每项 1 到 5 分)

维度看什么1 分5 分
正确性代码能否通过测试并满足需求明显不合格无需修改即可使用
改动范围是否只改了必要的地方明显不合格无需修改即可使用
可读性命名、结构是否符合项目风格明显不合格无需修改即可使用
安全性是否引入注入、越权或密钥泄露风险明显不合格无需修改即可使用
可维护性是否附带测试与必要说明明显不合格无需修改即可使用

建议:任一维度低于 3 分就不要直接使用;总分用于比较不同提示词或不同工具的效果。

用一个任务试打分

写技术文档

准备材料:一个模块的源码。

根据源码为这个模块写 README:用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。

检查点:示例代码可运行。

怎么让评分更可靠

  • 同一批材料至少测 5 次,不只看最好的一次。
  • 两人分别打分,分歧大的维度再讨论标准。
  • 把 Sourcery 的结果与人工完成或 CodeRabbit 的结果放在一起盲评。
  • 每次改提示词后用同一批材料复测。

补充练习

小功能开发

适用情况:手头有一个清晰的需求描述时。

实现以下需求:【需求】。要求:先给出实现计划和要改动的文件列表,等我确认后再写代码;遵循现有代码风格;补充必要的测试。

检查点:先有计划再动手。

读懂陌生代码库

适用情况:手头有一个刚接手的项目仓库时。

先不要改任何代码。请阅读这个仓库,输出:1)目录结构说明;2)主要模块之间的调用关系;3)本地运行步骤;4)你认为最脆弱的 3 个地方。

验收标准:运行步骤能实际跑通。

修复报错

输入:一段报错堆栈和相关代码。

这是报错信息和相关代码。请先解释报错原因,给出最小修改方案,并说明为什么这个修改不会影响其他调用方。

验收标准:修改范围足够小。

常见问题:测试全绿但功能不对

人工补充关键用例,检查测试是否真正断言了结果。

常见问题:生成的代码引用了不存在的函数

让它先搜索代码库确认 API,再写实现;运行测试验证。

常见问题:AI 改动范围过大

要求先给计划和文件清单,限定只改指定文件。

概念补充:编程智能体

能读写多个文件、运行命令并迭代修复的 AI,需要控制权限。

概念补充:MCP

让编程工具连接外部数据和工具的协议。

适合人群:咨询顾问

咨询顾问可以用 Sourcery 处理行业研究、访谈整理等工作。需要注意:客户机密遵守保密协议,研究结论注明来源。

适合人群:研究生

研究生可以用 Sourcery 处理文献阅读、开题与论文写作等工作。需要注意:遵守学校学术诚信规定,AI 只用于辅助理解和润色。

使用提醒

本文基于 Sourcery 公开的定位与通用用法编写,具体功能、套餐与可用地区以官方页面为准,产品更新后界面和名称可能变化。

所有示例输出均为示意,不代表真实统计或效果承诺;请以自己的测试结果为准。

延伸阅读