Augment Code 是一款插件 / 扩展：面向大型代码库的 AI 编程助手。

这篇写给软件工程师：围绕代码阅读与重构、测试与排错和技术文档这几类日常工作，说明它能帮上什么忙、怎么用、哪些地方必须自己把关。

软件工程师的三个高频用法

1. 代码阅读与重构

在 Augment Code 中可以这样提：

先不要改代码。阅读这个模块，画出主要函数的调用关系，指出可以安全重构的部分和风险点，再给出分步重构计划。

把关：先计划后改动。

2. 测试与排错

在 Augment Code 中可以这样提：

这是失败的测试输出和相关代码，请定位原因，给出最小修复，并补一个能防止回归的测试用例。

把关：修复后测试通过。

3. 技术文档

在 Augment Code 中可以这样提：

根据这段代码和注释生成接口文档：参数、返回值、错误码、调用示例，示例必须能直接运行。

把关：示例代码可运行。

也可以试试：补单元测试

这是「编程与开发」类工具的通用任务，软件工程师同样用得上。

为【函数名】编写单元测试，覆盖正常输入、边界值和异常输入，使用项目现有的测试框架，不要修改被测代码。先列测试用例再写代码。

边界与合规

不要把密钥和未开源代码上传到未授权工具，合并前审阅每处改动。

  • 产出由软件工程师本人负责，AI 只是草稿和辅助。
  • 对外内容发布前至少看一遍。
  • 如单位有规定的工具清单，优先在清单内选择；Augment Code 的同类还有 Cursor、Sourcegraph。

一周试用建议

选一个最常做的任务连续用 5 个工作日，记录每次节省的时间和需要修改的地方，再决定是否把 Augment 纳入日常流程。

补充练习

读懂陌生代码库

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

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

交付前确认：运行步骤能实际跑通。

写技术文档

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

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

交付前确认：示例代码可运行。

代码审查

准备材料：一个 Pull Request 的改动。

审查这个改动，按「必须修改 / 建议修改 / 可以忽略」三级列出问题，每条附上文件和行号，重点关注安全、并发和错误处理。

验收标准：问题定位到行。

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

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

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

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

常见问题：泄露密钥的风险

把密钥放在环境变量，规则文件中禁止读取 .env 等敏感文件。

概念补充：上下文索引

把代码库建立索引，让 AI 回答时能引用相关文件。

概念补充：规则文件

放在仓库里的说明文件，告诉 AI 项目约定和禁止事项。

使用提醒

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

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

延伸阅读