CodeBuddy 的生成质量很大程度上取决于你描述需求的精准度。提示词不必复杂,但需要把"做什么、给谁用、有什么限制"交代清楚。掌握以下方法,能显著减少返工次数。
4.2.1 高质量代码生成的描述公式
一个实用的提示词通常包含四个要素,按顺序组织即可:
- 背景:当前所处的业务或技术上下文(如:"这是电商订单模块" / "基于 React 18 的前端组件")。
- 任务:具体要完成的动作(如:"写一个计算满减价格的函数")。
- 约束条件:必须遵守的技术限制(如:"Python 3.8+,不引入第三方库,时间复杂度 O(n)")。
- 输出要求:期望的返回形式(如:"只输出函数代码和 Docstring,不要调用示例")。
对比示例
❌ 模糊的写法:"写个排序代码。"
✅ 清晰的写法:"用 Python 写一个函数,对包含订单金额的字典列表按 amount 字段降序排列,要求稳定排序且不修改原列表。只返回函数定义和标准库依赖。"
背景与约束越明确,AI 越能避开猜测,直接给出可用代码。
4.2.2 复杂需求分步拆解方法
不要试图用一句话让 AI 一次性生成整套系统。复杂需求建议拆成多轮对话,逐层推进:
- 先定骨架:让 AI 生成接口定义、函数签名或类结构,确认输入输出与模块划分是否合理。
- 再填核心:基于已确认的骨架,逐个函数或逐个模块要求实现具体逻辑。此时可结合
@文件引用已生成的代码,保持上下文连贯。 - 最后补全:核心逻辑跑通后,再要求补充异常处理、日志、单元测试或性能优化。
每轮对话聚焦一个明确目标,既便于你审查中间结果,也能让 AI 在更清晰的上下文里工作。若某一步生成结果偏离预期,及时在当前轮次纠正,再进入下一步,避免错误累积。
4.2.3 高频场景指令模板
以下模板可直接套用,根据实际项目填入括号内容即可。
- 从零生成函数
"请写一个 [语言] 函数,实现 [功能]。输入为 [参数说明],返回 [返回说明]。要求:[异常处理/性能/线程安全等限制]。"
- 解释与 Review
"请逐行解释这段代码的逻辑,并指出潜在的边界问题或性能隐患。@[目标文件]"
- Bug 定位修复
"运行时遇到以下错误:[粘贴报错信息] 或 @[终端]。请分析根因,并给出最小改动范围的修复代码。"
- 重构优化
"请重构以下代码,要求 [提取公共函数/降低圈复杂度/改用策略模式等]。保持原有行为不变,并说明改动点。"
- 批量加注释
"为以下代码添加符合 [Google Style/PEP 257/JSDoc] 规范的注释,不要改变任何逻辑。"
- 跨语言转换
"将以下 [语言A] 代码转换为 [语言B],保持逻辑一致,并使用目标语言的惯用写法。"
使用模板时,若涉及项目内已有代码,记得通过 @文件 或 @目录 引入上下文,避免 AI 凭空假设 API 或数据结构。