给软件工程师的 Sourcery 上手指南:步骤、提示词与注意事项
Sourcery 是一款在线服务:AI 代码审查与重构建议工具。
这篇写给软件工程师:围绕代码阅读与重构、测试与排错和技术文档这几类日常工作,说明它能帮上什么忙、怎么用、哪些地方必须自己把关。
软件工程师的三个高频用法
1. 代码阅读与重构
提示词示例:
先不要改代码。阅读这个模块,画出主要函数的调用关系,指出可以安全重构的部分和风险点,再给出分步重构计划。
把关:先计划后改动。
2. 测试与排错
提示词示例:
这是失败的测试输出和相关代码,请定位原因,给出最小修复,并补一个能防止回归的测试用例。
把关:修复后测试通过。
3. 技术文档
在 Sourcery 中可以这样提:
根据这段代码和注释生成接口文档:参数、返回值、错误码、调用示例,示例必须能直接运行。
把关:示例代码可运行。
也可以试试:修复报错
这是「编程与开发」类工具的通用任务,软件工程师同样用得上。
这是报错信息和相关代码。请先解释报错原因,给出最小修改方案,并说明为什么这个修改不会影响其他调用方。
边界与合规
不要把密钥和未开源代码上传到未授权工具,合并前审阅每处改动。
- 产出由软件工程师本人负责,AI 只是草稿和辅助。
- 对外内容发布前至少看一遍。
- 如单位有规定的工具清单,优先在清单内选择;Sourcery 的同类还有 CodeRabbit、Qodo。
一周试用建议
选一个最常做的任务连续用 5 个工作日,记录每次节省的时间和需要修改的地方,再决定是否把 Sourcery 纳入日常流程。
更多可以试的用法
小功能开发
准备材料:一个清晰的需求描述。
实现以下需求:【需求】。要求:先给出实现计划和要改动的文件列表,等我确认后再写代码;遵循现有代码风格;补充必要的测试。
交付前确认:先有计划再动手。
读懂陌生代码库
适用情况:手头有一个刚接手的项目仓库时。
先不要改任何代码。请阅读这个仓库,输出:1)目录结构说明;2)主要模块之间的调用关系;3)本地运行步骤;4)你认为最脆弱的 3 个地方。
交付前确认:运行步骤能实际跑通。
代码审查
准备材料:一个 Pull Request 的改动。
审查这个改动,按「必须修改 / 建议修改 / 可以忽略」三级列出问题,每条附上文件和行号,重点关注安全、并发和错误处理。
检查点:问题定位到行。
常见问题:越改越乱
回滚到上一个可用提交,把需求拆小后重新开始。
常见问题:测试全绿但功能不对
人工补充关键用例,检查测试是否真正断言了结果。
常见问题:泄露密钥的风险
把密钥放在环境变量,规则文件中禁止读取 .env 等敏感文件。
概念补充:MCP
让编程工具连接外部数据和工具的协议。
概念补充:上下文索引
把代码库建立索引,让 AI 回答时能引用相关文件。
注意事项
本文基于 Sourcery 公开的定位与通用用法编写,具体功能、套餐与可用地区以官方页面为准,产品更新后界面和名称可能变化。
文中提示词和示例仅作示意,实际效果取决于你的材料和 Sourcery 当前版本,重要内容请人工核对后再使用。