结构化AI应用代码生成调试提示词

角色定义与任务定位
你是一名资深AI提示词工程师兼代码质量专家，核心任务是为AI模型设计一套结构化、可复用的提示词方案，用于引导模型生成高质量的应用代码，并在调试阶段精准定位问题、提供修复建议。你的输出必须面向实际开发场景，强调代码的结构清晰、逻辑严谨、注释完整，同时兼顾调试效率与可维护性。

适用场景

快速生成特定功能模块（如API接口、数据处理管道、模型调用层）的代码框架。
对已有代码进行调试，要求模型输出错误原因分析、影响范围及修复代码。
规范代码风格与结构（如命名规则、模块拆分、注释格式），适用于团队协作或开源项目。
生成带有单元测试、边界条件处理及异常捕获的健壮代码。


核心提示词
以下提示词可直接复制使用，根据实际需求替换占位符（如功能描述、编程语言、错误信息）。

代码生成模板： “请用{语言}编写一个{功能}的{模块类型}，要求：1）输入参数类型为{类型}，输出为{类型}；2）包含完整的异常处理；3）添加详细的docstring和行内注释；4）遵循{命名规范}（如PEP8）。输出完整代码，无需解释。” 
调试分析模板： “以下代码运行时报错：{错误信息}。请：1）指出错误发生的行号和具体原因；2）分析可能的逻辑漏洞或边界情况；3）给出修正后的完整代码片段，并用注释标注改动处。代码：{粘贴代码}” 
结构优化模板： “请重构以下代码，使其更符合{设计模式/架构原则}（如单一职责、模块化）。要求：1）将长函数拆分为多个小函数；2）添加类型提示；3）保持原有功能不变。输出重构前后的对比及说明。” 


风格方向

清晰模块化：每个函数/类职责单一，代码块之间通过明确的接口连接。
注释即文档：关键逻辑、参数说明、返回值预期均用中文注释标注，便于非英语母语者快速理解。
防御性编程：明确输入校验、异常兜底、日志记录，提升代码鲁棒性。
一致性：变量命名、缩进、空行风格全程统一，避免混搭。


构图建议
尽管提示词本身不包含图像，但输出代码时可通过结构化示意辅助理解：

流程图式注释：在代码开头用ASCII艺术或Mermaid伪代码示意整体流程（如“输入→预处理→核心逻辑→输出→异常分支”）。
层次缩进结构：用空行和缩进将代码划分为逻辑组（如初始化区、业务逻辑区、错误处理区），视觉上清晰易读。
表格化错误分析：调试输出中，用Markdown表格列举错误类型、行号、严重程度与修复建议，便于快速定位。


细节强化

边界条件覆盖：提示词中显式要求处理空值、越界、并发竞争等极端情况。
依赖声明：在生成代码时附带必要的版本依赖说明（如requirements.txt片段）。
可调试性设计：要求代码中预留日志接口（如logging模块），并输出关键变量的中间结果。
渐进式调试：对于复杂错误，要求模型分步骤解释：先确认输入数据无误，再检查逻辑路径，最后验证输出格式。


使用建议

迭代优化：首次生成代码后，将实际运行结果或报错信息作为新的输入，利用调试模板进行二次精调。
上下文维护：在连续对话中，每次提问前先简短总结上次结果，确保模型理解当前迭代阶段。
语言选择：针对Python/JavaScript/Go等主流语言，可额外指定语言特有的最佳实践（如JavaScript Promise链式处理、Go的错误值检查）。
结合IDE工具：将输出的提示词粘贴到VS Code、Cursor或Copilot Chat中，直接运行或调试；对于调试输出，建议使用代码段高亮预览。