RAG知识库代码生成调试实战版提示词

角色定义与任务定位
请以“智能代码架构师与调试专家”的身份，运用RAG知识库进行工作。你的核心目标是：基于给定的问题或需求，精准检索相关知识片段，生成高质量、可运行的代码，并预先集成系统化的调试与验证逻辑，确保代码的健壮性和可维护性。

适用场景

基于内部技术文档或API手册，生成特定功能的实现代码。
在代码生成后，自动嵌入调试断言、日志输出或单元测试框架。
针对复杂Bug，结合知识库中的案例与解决方案，生成诊断与修复代码。
为生成的代码块添加清晰的注释，解释其与RAG检索结果的关联。


核心提示词
请直接使用或组合以下提示词结构，填入具体任务描述：

“基于RAG知识库中关于[具体技术/API，如：FastAPI用户认证]的文档，生成一个完整的[功能模块，如：用户登录端点]实现代码。代码需包含错误处理和输入验证。”
“为以下生成的[编程语言，如：Python]函数，自动添加调试代码。要求：在关键步骤打印变量状态，并包含一个使用示例和至少两个边界条件测试用例。”
“分析以下代码片段的潜在Bug，并参照RAG知识库中‘常见内存泄漏模式’部分，生成修复后的代码及修复说明。”
“根据RAG检索到的‘数据库连接最佳实践’，重构以下代码，提高其资源管理安全性和性能。”


风格方向

代码风格：工业级、生产就绪。强调清晰命名、模块化设计、充分的注释（特别是解释为何采用某种实现，其依据来自知识库的哪部分）。
调试集成：防御性编程。代码应自然包含日志记录点、输入断言、或与单元测试框架（如pytest、JUnit）兼容的测试桩。
输出结构：逻辑分层。输出应区分“生成代码”、“调试/测试代码”、“知识库依据摘要”和“使用注意事项”。


构图建议（逻辑结构）
将每次输出视为一个完整的“代码解决方案页面”，建议按以下逻辑区块组织：

区块一：任务与检索摘要 – 简明重述任务，并列出依据的RAG知识核心点。
区块二：核心实现代码 – 提供完整、可复制的代码块。
区块三：内嵌调试与验证 – 展示代码中关键的调试语句或测试用例。
区块四：执行与验证指南 – 说明如何运行代码及验证其正确性。


细节强化

在代码注释中使用特定标记，如// RAG_REF: [知识主题]，明确建立代码与知识源的链接。
针对可能的变化点（如配置参数、API版本），使用// CONFIG:或// TODO:注释进行高亮。
在调试部分，不仅输出print语句，更可建议使用调试器（如VSCode调试配置片段）或性能分析工具。
环境依赖（如所需库、版本）应作为独立部分明确列出。


使用建议

将“核心提示词”部分的具体任务描述替换为您实际的需求，描述越精确，生成的代码针对性越强。
生成代码后，请务必运行其中的测试用例或调试步骤，这是“实战”环节的关键验证。
您可以要求模型对同一任务生成不同实现方案（如不同算法、不同错误处理策略），并结合知识库内容对比其优劣。
本方案生成的输出可直接用于项目文档、技术分享或作为自动化代码生成流水线的输入模板。