用好 IDE 中的 AI 编程协作的检查清单(可收藏)
这是一份 IDE 中的 AI 编程协作检查清单,复制到笔记里,每次使用前过一遍。AI 编程助手是集成在代码编辑器或开发环境中的 AI 功能,能补全代码、解释代码、根据注释生成函数、重构、写测试,部分工具还能在理解整个项目的基础上执行多文件修改。工作流类技能的价值在于把 AI 嵌进你已有的流程里,而不是另起炉灶。先挑一个最常做、最费时的环节试点,效果稳定后再扩展。
适合对照清单的时刻
- 阅读不熟悉的代码库,需要快速理解。
- 为已有代码补充测试和注释。
清单的意义在于:它写得越快,你审得越要仔细。
使用前
- 选择适合你技术栈的编程助手,并确认公司对代码外发的规定。
- 在任务开始前说明目标、约束和相关文件。
- 让 AI 先给出修改计划,确认后再生成代码。
- 确认材料中不包含服务器 IP、账号口令、证书私钥和内部拓扑,必要时先脱敏。
使用中
- 逐段审阅生成的代码,理解每一处修改。
- 运行测试和代码检查工具,确认没有引入问题。
- 拆成小任务,每次修改范围可控、便于评审。
- 说明框架、风格、依赖限制,避免生成不兼容的代码。
使用后
- 提交前做代码评审,保持小步提交,便于回滚。
- 运行测试和静态检查,保持小步提交。
- 对外发出前已由自己通读并确认。
- 运维工程师特别注意:排障时把日志片段、时间线和最近变更一起提供,让 AI 帮你列排查顺序。
红线清单
- 不看就接受生成的代码。
- 一次让 AI 改动大量文件。
- 不说明项目约束。
- 把密钥和内部配置贴给 AI。
配套模板
清单配合下面的模板使用效果更好:
背景:我们的项目是把发布流程迁移到容器化部署相关的服务,使用[语言/框架]。
任务:在[文件路径]中新增一个函数,实现[功能描述]。
约束:
- 遵循项目现有的命名和错误处理方式;
- 不引入新的第三方依赖;
- 输入为空或格式错误时返回明确的错误信息。
请先说明你的实现思路和需要修改的文件,等我确认后再写代码,并附上对应的单元测试。
按清单完成后,结果大致会是这样(虚构示例):
示例(虚构):一位后端开发让编程助手为一个旧模块补充参数校验。助手先列出需要修改的三个函数和校验规则,确认后生成代码和测试。运行测试时有一个用例失败,助手分析出是旧代码对空字符串的处理不一致,开发者决定保留旧行为并调整了测试。
让清单更好用的两个习惯
- 让 AI 先写修改计划,比直接写代码更容易发现方向错误。
- 出错时把完整报错和相关代码一起提供,定位更快。
清单之外
编程助手会泄露公司代码吗? 取决于工具的部署方式和数据政策,使用前确认公司规定,必要时选择企业版或本地方案。
AI 改错了怎么办? 使用版本控制,小步提交,出错时可以快速回滚。
清单的使用建议
清单的意义在于把容易忘的动作固定下来。刚开始每一项都勾一遍,几次之后你会发现真正容易漏的只有两三项,把它们标红即可。如果你是运维工程师,处理“处理 2 起磁盘告警和 1 起证书过期隐患”这类工作前过一遍清单,最能体现价值。