AI编程Prompt
7758 字约 26 分钟
domain/aiai/promptai/codingai/prompt-engineering
2026-07-24
编程场景的 Prompt 设计与通用 Prompt 的最大区别在于:代码是可执行、可测试、可审查的——Prompt 的产出质量可以被客观验证。这意味着编程 Prompt 需要更精确的上下文、更严格的约束、更结构化的输出。
1. 核心问题
AI 编程 Prompt 试图回答:
- 如何让 AI 生成"生产级"代码(可维护、可测试、有错误处理)而非"演示级"代码?
- 不同编程语言和框架需要怎样的 Prompt 差异?
- 使用 Cursor / Claude Code / Copilot 等不同工具时,Prompt 策略有何不同?
- 如何用 Prompt 控制 AI 的编程行为——安全、风格、约束?
2. 仓库全量模板索引
本仓库编码相关的 Prompt 模板和规则文件分布在 02_Domains/AI/、04_Prompts/、03_Projects/ 三个目录,以下分类索引所有编码相关的可复用资源。
2.1 编码 Prompt 模板(04_Prompts/)
| 文件 | 模板数 | 内容 | 适用工具 |
|---|---|---|---|
| 04_Prompts/03_Codex/Codex任务提示词模板 | 3 | 基础编码模板、复杂任务模板、输出格式模板 | Codex CLI |
| 04_Prompts/03_Codex/Codex代码修改提示词 | 1 | 代码修改专用(搜索优先、最小改动、复用现有代码) | Codex CLI |
| 04_Prompts/03_Codex/Codex重构提示词 | 1 | 重构专用(不改变外部行为、小步重构) | Codex CLI |
| 04_Prompts/03_Codex/Codex排查问题提示词 | 1 | Bug 排查专用(症状→调查→根因→最小修复) | Codex CLI |
| 04_Prompts/03_Codex/Codex项目初始化提示词 | 1 | 新项目初始化(框架、语言、目录结构、配置) | Codex CLI |
| 04_Prompts/03_Codex/Codex项目规则模板 | 1 | AGENTS.md 模板(搜索优先、代码复用、最小改动) | Codex CLI 项目 |
| 04_Prompts/04_Claude_Code/Claude Code任务提示词模板 | 2 | 基础编码任务模板、分析任务模板(只读/问题优先级) | Claude Code |
| 04_Prompts/04_Claude_Code/Claude Code项目规则模板 | 1 | CLAUDE.md 模板(搜索优先、代码复用、禁止构建命令) | Claude Code 项目 |
| 04_Prompts/05_Cursor/Cursor任务提示词模板 | 3 | 代码修改模板、代码分析模板、Bug 修复模板 | Cursor Chat/Composer |
| 04_Prompts/05_Cursor/Cursor Rules模板 | 3 | 通用 .cursorrules 模板、iOS 项目模板、前端项目模板 | Cursor Rules |
| 04_Prompts/06_ChatGPT/ChatGPT代码分析提示词 | 3 | 代码解读模板、架构分析模板、性能分析模板 | ChatGPT |
2.2 编码工作流(04_Prompts/07_Workflows/)
| 文件 | 内容 | 适用阶段 |
|---|---|---|
| 04_Prompts/07_Workflows/代码审查工作流 | 标准化五步审查流程(了解变更→审查代码→审查设计→反馈→确认) | 审查阶段 |
| 04_Prompts/07_Workflows/Bug排查工作流 | 六步 Bug 排查流程(复现→定位→根因→修复→验证→归档) | Debug 阶段 |
| 04_Prompts/07_Workflows/需求分析工作流 | 五步需求拆分流程(背景→功能拆解→技术评估→任务拆分→风险识别) | 需求阶段 |
| 04_Prompts/07_Workflows/部署排查工作流 | 五步部署问题排查流程(确认→收集→定位→解决→复盘) | 运维阶段 |
2.3 Agent 规则模板(04_Prompts/02_Agent_Rules/)
| 文件 | 内容 | 适用项目类型 |
|---|---|---|
| 04_Prompts/02_Agent_Rules/01_Core/通用AGENTS模板 | 通用 AGENTS.md 模板(任务路由、Superpowers、禁止命令、最小改动) | 任意编码项目 |
| 04_Prompts/02_Agent_Rules/04_Project_Templates/前端项目AGENTS模板 | 前端专用规则(组件复用、hooks 复用、搜索优先) | React/Vue/Next.js |
| 04_Prompts/02_Agent_Rules/04_Project_Templates/iOS项目AGENTS模板 | iOS 专用规则(API 文档查找、MVVM 复用、禁用 xcodebuild) | Swift/ObjC |
| 04_Prompts/02_Agent_Rules/04_Project_Templates/全栈项目AGENTS模板 | 全栈规则(API 契约不变、数据库 Schema 保护、禁用 db migration) | 全栈项目 |
| 04_Prompts/02_Agent_Rules/04_Project_Templates/大型遗留项目AGENTS模板 | 遗留项目规则(稳定性优先、可逆性、风险评估、不升级依赖) | 大型存量项目 |
| 04_Prompts/02_Agent_Rules/05_Task_Modes/代码审查模式 | 六维审查(正确性/安全性/性能/可读性/一致性/边界)+ 报告格式 | 审查模式 |
| 04_Prompts/02_Agent_Rules/05_Task_Modes/Bug修复模式 | Bug 修复标准化模式(理解→修复根因→最小修改) | Debug 模式 |
| 04_Prompts/02_Agent_Rules/05_Task_Modes/重构模式 | 重构标准化模式(不改变外部行为、小步前进、不混入功能修改) | 重构模式 |
| 04_Prompts/02_Agent_Rules/06_Examples/根目录AGENTS示例 | PetPal 项目 AGENTS.md 完整示例(技术栈、搜索规则、TODO 策略) | iOS 项目参考 |
| 04_Prompts/02_Agent_Rules/06_Examples/前端目录AGENTS示例 | 前端子目录 AGENTS 示例(React+TS、Tailwind CSS 约束) | 前端项目参考 |
| 04_Prompts/02_Agent_Rules/06_Examples/iOS目录AGENTS示例 | iOS 子目录 AGENTS 示例(UIKit/SwiftUI、ViewModel 模式) | iOS 项目参考 |
| 04_Prompts/02_Agent_Rules/06_Examples/API目录AGENTS示例 | API 子目录 AGENTS 示例(controller/service/model 分层、Prisma) | 后端项目参考 |
| 04_Prompts/02_Agent_Rules/06_Examples/Nginx目录AGENTS示例 | Nginx 配置目录 AGENTS 示例(配置安全、语法验证、保留备份) | 运维项目参考 |
2.4 编码工具规范(02_Domains/AI/07_AI_Coding/)
| 文件 | 内容 | 适用工具 |
|---|---|---|
| Claude Code使用规范 | 工作流程(启动→理解→执行→修改→验证)、最佳实践、常用命令 | Claude Code |
| Codex使用规范 | 工作流程(初始化→任务描述→规划→执行→迭代)、安全注意事项 | Codex CLI |
| Cursor使用规范 | Tab 补全、Chat、Composer、@ 引用系统、配置建议 | Cursor |
| Copilot使用规范 | Tab 补全、Copilot Chat、Inline Chat 最佳实践 | GitHub Copilot |
| Qoder使用规范 | 中文优化编码辅助工具规范 | Qoder |
| Trae使用规范 | Builder 模式、Chat 模式、多文件编辑 | Trae |
| AI编程工具总览 | 10 个工具的分类对比 | 工具选型 |
| AI Coding工具对比 | 底层模型、核心功能、定价、工作流适配的详细对比 | 工具选型 |
2.5 编码领域知识(02_Domains/AI/07_AI_Coding/)
| 文件 | 内容 | 适用场景 |
|---|---|---|
| AI代码审查 | 审查流程、6 个审查维度和示例 Prompt | 代码审查方法论 |
| AI重构工作流 | 重构五阶段(识别→计划→执行→验证→文档)+ 常用重构模式 | 重构方法论 |
| AI辅助Debug | 错误分析、根因定位、修复建议方法论 | Debug 方法论 |
| AI辅助架构设计 | 架构规划、技术选型方法论 | 架构设计方法论 |
| AI生成测试 | 单元测试、集成测试、E2E 测试生成策略 | 测试方法论 |
| AI生成文档 | 代码注释、API 文档、README 生成策略 | 文档方法论 |
| AI Coding反模式 | 编码反模式总结(过度依赖 AI、不审查、忽略安全等) | 反模式排查 |
| Agent.md规范 | AGENTS.md 编码项目使用规范 | 规则文件设计 |
| Rules规则文件管理 | Cursor Rules、Claude Instructions 等规则格式和继承策略 | 规则管理 |
| Memory Layer设计 | 记忆层设计(项目上下文、编码习惯、历史决策) | 上下文管理 |
| Superpower使用边界 | 什么是安全自动执行、什么需要人工确认 | 权限边界 |
| 前端AI Coding工作流 | React/Vue 组件、样式、状态管理的 AI 流程 | 前端场景 |
| 后端AI Coding工作流 | API 端点、数据库操作、中间件的 AI 流程 | 后端场景 |
| iOS AI Coding工作流 | SwiftUI、网络层、Core Data 的 AI 流程 | iOS 场景 |
| AI Coding工作流 | 整体工作流框架 | 全局流程 |
2.6 项目级 Agent 规则
| 文件 | 内容 | 适用项目 |
|---|---|---|
| 03_Projects/PetPal/Agent规则/AGENTS | PetPal 编码项目 Agent 策略(语言策略、工作流、工具路由、成本策略) | PetPal(iOS) |
| 03_Projects/PetPal/Agent规则/CLAUDE | Claude 补充规则(中文输出、API 查 Apifox MCP、Figma 查 Figma MCP) | PetPal(iOS) |
| 02_Domains/Engineering/Frontend/12_AIFrontend/PromptEngineering/PromptEngineering-Frontend | Prompt 工程前端实现(Monaco 编辑器、多角色编辑、变量管理、模板系统) | 前端工程参考 |
2.7 本笔记(03_Prompt_Engineering/)中的模板
| 章节 | 内容 | 适用场景 |
|---|---|---|
| 4.1 代码生成 | 通用代码生成 Prompt 结构(Role/Task/Context/Requirements/Constraints/Output) | 从需求到实现 |
| 4.2 Debug | 四步排查 Prompt(复述→根因→排查→修复 + Attempts/Constraints) | Bug 修复 |
| 4.3 代码审查 | 六维审查 Prompt(P0/P1/P2 分层 + 严重程度输出) | PR/MR 审查 |
| 4.4 架构设计 | 八输出结构架构 Prompt(方案概述→组件→数据流→选型→权衡→演进→风险) | 系统设计 |
| 8 T1-T10 | 10 个轻量模板(函数/API/查询/测试/重构/类型/错误/配置/迁移/文档) | 快速启动 |
3. 核心框架:需求→架构→实现→测试
编程场景的 Prompt 应遵循"逐步具象化"的框架。每一步的抽象程度递减、具体程度递增。
3.1 分步 vs 一轮
| 方式 | 适用场景 | Prompt 策略 |
|---|---|---|
| 一轮完成 | 简单任务(< 50 行、单一文件) | 一次给出完整需求 + 架构 + 约束 |
| 分步完成 | 复杂任务(多文件、架构决策) | 先讨论架构 → 再逐文件实现 → 最后测试 |
分步策略的 Prompt 模式:
第 1 步:「我要实现功能 X,有哪些架构方案?各自的权衡是什么?」
第 2 步:「选择方案 A,请给出文件结构和接口定义。」
第 3 步:「实现文件 A,要求包含错误处理和类型注解。」
第 4 步:「为文件 A 生成单元测试,覆盖正常路径和边界情况。」3.2 有效编程 Prompt 的六大要素
| 要素 | 说明 | 差 | 好 |
|---|---|---|---|
| 语言/框架 | 精确到版本 | "写个 API" | "用 Python 3.12 + FastAPI 写一个 REST API" |
| 上下文 | 相关代码和接口 | 无 | 附上现有 Model 层和 Router 实现 |
| 约束 | 编码规范和限制 | "代码写好点" | "使用 type hints,不要用 Any" |
| 安全考量 | 安全要求和边界 | "写个登录功能" | "密码用 bcrypt 哈希,JWT 过期时间 24h" |
| 输出结构 | 期待的产出形式 | "给我代码" | "先一句话说明思路,再输出完整的代码块" |
| 验收标准 | 怎样算完成 | "写个测试" | "覆盖率 > 80%,包含正常路径 + 异常路径" |
4. 四大编程场景的 Prompt 模式
4.1 代码生成(需求 → 实现)
场景特征:从自然语言需求生成可运行的代码。核心挑战是需求模糊度和上下文完整性。
通用 Prompt 结构:
Role: 你是一位 {{语言}} 资深开发者,精通 {{框架}},注重代码质量和可维护性。
Task: 实现 {{功能}}。
Context:
- 项目技术栈: {{技术栈}}
- 已有接口: {{接口参考}}
- 数据模型: {{数据结构}}
Requirements:
1. {{功能需求1}}
2. {{功能需求2}}
3. {{功能需求3}}
Constraints:
- 类型安全(使用 TypeScript/Python type hints)
- 完整的错误处理
- 遵循 SOLID 原则
- {{其他约束}}
Output: 先说明实现思路(包括技术选型的原因),再输出完整代码块。参考模板:详见 Prompt模板库#1.1 代码生成 的完整模板。
进阶技巧:
- 指定代码风格:明确命名规范、文件组织方式、注释风格
- 注入现有代码:引用仓库中相同模式的代码作为风格参考
- 多文件生成:使用结构化标签分隔不同文件
请生成以下文件:
<file name="models/user.py">
用户数据模型
</file>
<file name="services/user_service.py">
用户业务逻辑
</file>
<file name="routes/user_routes.py">
用户 API 路由
</file>4.2 Debug(错误 → 分析 → 修复)
场景特征:给定错误信息,定位根因并修复。核心挑战是"症状"和"病因"的区分。
通用 Prompt 结构:
Role: 资深 Debug 工程师,擅长系统化排查问题。
Error: {{完整错误信息和堆栈}}
Code:
{{相关代码}}
Attempts: {{已经尝试过的方法}}
Process:
1. 复述你对问题的理解(验证我是否说清楚了)
2. 列出可能的根因,按概率排序
3. 逐一排查,排除低概率原因
4. 给出修复方案
Constraints:
- 做最小改动,不要重构不相关的代码
- 如果涉及第三方库,先检查使用方式而非假设库有 bug
- 修复后说明"你的修复解决的是什么问题"(防止治标不治本)参考模板:详见 Prompt模板库#1.3 Debug 助手。
调试信息组织:
| 信息类型 | 重要性 | 说明 |
|---|---|---|
| 完整错误堆栈 | 必要 | 截断的堆栈会导致 AI 误判根因 |
| 触发条件的输入 | 高 | 什么输入/操作会触发这个问题 |
| 已排除的原因 | 高 | 说明已尝试过的方法,避免 AI 重复建议 |
| 近期代码变更 | 中 | 最近修改了哪些相关代码 |
| 环境信息 | 中 | OS / 运行时版本 / 依赖版本 |
4.3 代码审查(标准 → 检查 → 反馈)
场景特征:审查已有代码的质量、安全性和可维护性。核心挑战是"审查深度"与"审查范围"的平衡。
通用 Prompt 结构:
Role: 资深 Code Reviewer,注重安全性、性能、可维护性。
Task: 审查以下 Pull Request 的代码。
Context:
- 项目类型: {{项目描述}}
- 本次变更目标: {{需求描述}}
Checklist(按优先级审查):
1. [P0] 安全漏洞:注入/XSS/认证/授权/SQL
2. [P0] 逻辑错误:边界条件、并发问题、事务完整性
3. [P1] 错误处理:异常捕获、日志、用户反馈
4. [P1] 性能问题:N+1 查询、不必要的重复计算、内存泄漏
5. [P2] 代码质量:命名、注释、复杂度、重复代码
6. [P2] 测试覆盖:测试是否覆盖了关键路径和边界情况
Code:
{{代码 diff 或完整文件}}
Output: 按严重程度(Critical/Major/Minor/Nit)排序,每个问题包含:
- 文件:行号
- 问题描述
- 具体风险
- 修复建议(不要只说"需要改进",给具体方案)参考模板:详见 Prompt模板库#1.2 代码审查。
审查深度的控制:
// 深度审查(适合关键模块)
审查所有 6 个维度,每个问题都要有"影响分析"和"修复建议"
// 快速审查(适合常规 PR)
只审查 P0 + P1 级别问题,P2 级别只在超过 3 处时汇总说明
// 安全专项审查(适合涉及敏感数据的模块)
只审查 Checklist 的 #1(安全),其他维度跳过4.4 架构设计(需求 → 设计 → 权衡 → 文档)
场景特征:从高维需求出发,设计方案并权衡取舍。核心挑战是让 AI "看到"非功能性约束(扩展性、可维护性、成本)。
通用 Prompt 结构:
Role: 软件架构师,擅长 {{领域}} 系统的架构设计,注重扩展性、可维护性和成本平衡。
Task: 为以下需求设计架构方案。
Requirements:
{{功能需求}}
{{非功能需求(性能/可用性/成本/安全)}}
Context:
- 现有系统: {{现有架构描述}}
- 团队规模: {{人数和技能分布}}
- 时间约束: {{交付时间线}}
Output Structure:
1. 方案概述(一句话说明核心架构风格)
2. 架构图(文字/组件关系描述)
3. 核心组件说明(每个组件的职责和接口)
4. 数据流(关键场景的请求链路)
5. 技术选型(核心依赖 + 选型理由 + 备选方案)
6. 主要权衡(这个方案牺牲了什么、换来了什么)
7. 演进路线(MVP → 迭代 → 长期)
8. 风险点(已知风险和缓解措施)关键技巧:
- 场景驱动:不是让 AI 凭空设计,而是给出具体的用户场景和流量预期
- 约束明确:没有约束的设计毫无意义——必须给出资源、时间、技能约束
- 权衡优先:好的架构设计不在于"最好的方案",而在于"方案的可比性"
// 对比分析的 Prompt
请给出 3 个可选方案,用以下维度对比:
| 维度 | 方案A | 方案B | 方案C |
| 开发成本 | | | |
| 扩展性 | | | |
| 运维复杂度 | | | |
| 学习曲线 | | | |
推荐方案 + 理由 + 主要风险5. 语言特定的 Prompt 策略
5.1 TypeScript
TypeScript 的强类型系统是 AI 编程的"天然护城河"——类型推断帮助 AI 理解上下文,类型错误暴露 AI 的幻觉。
// 对 TypeScript 的额外约束
Constraints:
- 启用 strict 模式
- 使用 branded types 区分相同基础类型的不同含义(如 type UserId = string & {__brand: 'UserId'})
- 使用 discriminated union 处理状态
- 避免 any 和 type assertion(as)
- 使用 satisfies 关键字代替 type assertion最佳实践:先将类型定义(interface / type)给 AI,再要求实现——类型先行可以大幅降低逻辑错误。
5.2 Python
Python 的动态类型让 AI 容易"偷懒"——不加类型注解、不处理异常边界。
// 对 Python 的额外约束
Constraints:
- 所有函数必须有完整的 type hints
- 使用 dataclass 或 Pydantic 定义数据模型
- 每个函数包含 docstring(含 Args 和 Returns 说明)
- 使用 Result/Option 模式替代 bare Exception
- 遵循 PEP 8(行长度、命名约定)最佳实践:Python 中 AI 最常犯的错误是"类型不兼容"和"忽略可变默认参数",在 Prompt 中明确要求这两个检查点。
5.3 Rust
Rust 的所有权和生命周期是 AI 编程的最大挑战——AI 经常生成"借用检查器不通过"的代码。
// 对 Rust 的额外约束
Constraints:
- 所有函数必须通过 cargo check(编译检查)
- 优先使用迭代器和闭包而非 for 循环
- 使用 thiserror / anyhow 进行错误处理
- 避免 unsafe 代码块。如果无法避免,详细说明为什么
- 使用 clippy 推荐的代码风格最佳实践:对 Rust,要求 AI 先生成类型定义(struct / enum / trait),再生成实现。类型结构一旦确定,逻辑错误的概率大幅降低。
5.4 Swift
Swift 的 iOS/macOS 生态有大量框架知识要求(UIKit/SwiftUI/Combine/CoreData)。
// 对 Swift 的额外约束
Constraints:
- 使用 Swift 最新版本特性
- SwiftUI 视图使用 @State / @Binding / @Observable
- 使用 Swift Concurrency(async/await)而非 GCD
- 遵循命名规范(PascalCase for types, camelCase for variables)
- 使用 MARK: 注释组织代码结构最佳实践:iOS AI Coding 的完整工作流见 iOS AI Coding工作流。
6. 框架特定的 Prompt 策略
| 框架 | 约束重点 | 示例约束 |
|---|---|---|
| React/Next.js | Hooks 规则、服务端组件 | "使用 React 19 的 use() Hook,不要在条件语句中调用 hooks" |
| Vue 3 | Composition API 优先 | "使用 <script setup> + Composition API,不使用 Options API" |
| FastAPI | Pydantic 模型、依赖注入 | "所有请求/响应使用 Pydantic v2 模型,使用 Depends 管理依赖" |
| Django | ORM 查询、信号机制 | "使用 select_related/prefetch_related 优化 N+1" |
| Spring Boot | 依赖注入、事务管理 | "使用构造函数注入,@Transactional 标注事务边界" |
| Express/NestJS | 中间件、拦截器、管道 | "使用全局异常过滤器,使用 class-validator + class-transformer" |
7. 工具特定的 Prompt 策略
7.1 Cursor
Cursor 的核心能力是 代码库理解 和 Composer 多文件编辑。Prompt 策略围绕 @ 引用展开。
仓库资源:
- Cursor使用规范 — 工具操作方式和最佳实践
- Cursor任务提示词模板 — 三种轻量模板(修改/分析/Bug 修复)
- Cursor Rules模板 —
.cursorrules通用/前端/iOS 模板 - Cursor使用总览 — 入口概览
// Cursor Chat 中的 Prompt(利用 @ 引用)
@file:src/models/user.ts @file:src/services/auth.ts
请分析这两个文件,找出认证流程中的安全漏洞。
// Cursor Composer 中的 Prompt(多文件编辑)
@folder:src/features/payment
为这个支付模块添加 Stripe 集成,保持现有的错误处理和日志风格。关键技巧:Cursor 中不要重复描述代码库已有的内容——用 @ 引用比文字描述更精确、更省 token。Rules 文件(.cursorrules)应放在项目根目录,定义全局编码规范。
7.2 Claude Code
Claude Code 的核心能力是 CLI Agent 模式 和 MCP 集成。Prompt 策略围绕"任务描述"展开,Claude Code 自主规划和执行。
仓库资源:
- Claude Code使用规范 — 工具操作方式和最佳实践
- Claude Code任务提示词模板 — 基础编码任务 + 分析任务两种模式
- Claude Code项目规则模板 — CLAUDE.md 模板
- Claude Code使用总览 — 入口概览
// Claude Code CLI Prompt
在 src/services/ 目录下添加缓存层实现:
1. 使用 Redis 作为缓存后端
2. 保持现有接口不变
3. 添加 TTL 过期策略(默认 300s)
4. 为所有新代码编写单元测试
5. 不要修改 src/routes/ 和 src/models/ 下的文件关键技巧:
- 任务描述要给出范围边界(改什么、不改什么)
- Claude Code 擅长大范围重构,但需要约束"不要修改无关文件"
- MCP 集成后可以直接操作数据库、文件系统、API
- 根目录
CLAUDE.md中最顶层规则优先级最高,应放最重要的安全约束
7.3 Codex CLI
Codex CLI 的核心能力是 沙箱安全执行 和 Plan-then-Execute 模式。
仓库资源:
- Codex使用规范 — 工具操作方式和最佳实践
- Codex任务提示词模板 — 基础 + 复杂任务 + 输出格式模板
- Codex代码修改提示词 — 最小修改、搜索优先
- Codex重构提示词 — 不改变外部行为
- Codex排查问题提示词 — 症状→根因→最小修复
- Codex项目初始化提示词 — 项目脚手架生成
- Codex项目规则模板 — AGENTS.md 专用模板
- Codex使用总览 — 入口概览
// Codex CLI Prompt(Plan-then-Execute 模式)
Plan: 分析现有认证模块的架构,设计 JWT 刷新令牌方案。
实现:按照设计方案实现,包含完整的错误处理和单元测试。
安全约束:access_token 有效期 15 分钟,refresh_token 有效期 7 天,使用 httpOnly cookie。关键技巧:Codex CLI 的沙箱模式使其适合执行高风险操作(文件系统修改、代码执行),但需要在 Prompt 中明确恢复路径("如果失败请回滚")。
7.4 Copilot
Copilot 的核心能力是 行内补全 和 Chat 上下文理解。Prompt 策略围绕"渐进式引导"展开。
仓库资源:
- Copilot使用规范 — 工具操作方式和最佳实践
// Copilot 中的注释引导法
// 1. 验证输入参数(非空检查、类型检查)
// 2. 从数据库查询用户信息
// 3. 检查用户权限
// 4. 执行核心业务逻辑
// 5. 记录操作日志
// 6. 返回格式化结果关键技巧:Copilot 最适合"写一段代码的下一段"——利用注释和函数签名引导模型。Copilot 不适合一次性大范围修改,更适合逐行逐函数的增量编码。
7.5 ChatGPT(代码分析)
仓库资源:
- ChatGPT代码分析提示词 — 三种分析模板(代码解读/架构分析/性能分析)
ChatGPT 虽非专用编程工具,但其对话式交互适合代码分析和设计方案讨论:
分析以下代码的架构设计:
- 使用了什么设计模式?
- 有没有架构层面的问题?
- 如果需要添加新功能 XX,应该怎么扩展?
- 重构建议是什么?8. 模板速查(10 个可复用模板)
T1 函数生成
实现一个 {{函数名}} 函数:
- 参数:{{类型和说明}}
- 返回值:{{类型和说明}}
- 行为:{{具体行为}}
- 边界:{{边界条件}}
- 错误:{{可能的异常情况}}
代码包含类型注解、docstring、错误处理。T2 API 端点
创建一个 {{方法}} {{路径}} 端点:
- 请求体:{{Schema}}
- 响应:{{Schema}}
- 业务逻辑:{{描述}}
- 需要 {{认证/权限}} 检查
返回完整的路由文件(含依赖注入、模型定义)。T3 数据库查询
优化以下数据库查询:
当前 SQL/ORM:{{代码}}
表结构:{{Schema}}
数据量:{{行数}}
问题:{{性能问题描述}}
给出优化后的查询 + 加索引建议(如需)。T4 测试用例
为以下函数编写单元测试:
函数签名:{{签名}}
函数行为:{{描述}}
边界情况:{{已知边界}}
覆盖率要求:{{百分比}}
测试框架:{{pytest/jest/xctest}}
使用参数化测试覆盖多组输入。T5 代码重构(详见 Prompt反模式)
重构以下代码:
问题:{{代码坏味道描述}}
目标:{{重构后的期望}}
约束:保持对外接口不变,不做功能变更
列出本次重构的修改清单。T6 类型定义设计
为以下领域设计类型定义:
领域描述:{{描述}}
使用场景:{{场景}}
语言:{{语言}}
输出:interface/type/struct 定义 + 说明每个字段的设计理由。T7 错误处理规范
为以下模块设计错误处理方案:
模块:{{模块描述}}
语言:{{语言}}
输出:错误类型定义 + 错误处理器的实现 + 使用示例T8 配置管理
为 {{项目}} 设计配置方案:
环境:{{开发/测试/生产}}
配置项:{{配置项列表}}
安全要求:{{是否需要加密/脱敏}}
使用环境变量 + 配置文件两级方案。T9 迁移脚本
生成数据迁移脚本:
迁移内容:{{描述}}
源结构:{{Schema}}
目标结构:{{Schema}}
约束:迁移过程不能丢失数据,支持回滚T10 代码文档
为以下代码生成文档:
代码:{{代码文件}}
文档风格:{{JSDoc/Python Docstring/RustDoc}}
输出:完整的文档注释(每个函数/类/接口)+ 顶层 README 片段9. 编程 Prompt 的常见反模式
详见 AI Coding反模式 和 Prompt反模式 的完整讨论,以下是编程场景特有的反模式:
| 反模式 | 错误示范 | 正确方式 |
|---|---|---|
| 无上下文请求 | "写个用户注册接口" | 附上 Model 层、现有路由模式、认证方式 |
| 忽略安全 | "写个登录功能" | 指定密码哈希、JWT 配置、限流策略 |
| 无约束生成 | "优化这段代码" | 明确"优化维度优先级:可读性 > 性能 > 代码量" |
| 单一轮次大任务 | "实现一个完整的电商系统" | 拆分为数据模型 → API → 业务逻辑 → 前端 |
| 不指定测试策略 | "写个测试" | 指定测试框架、覆盖率目标、mock 策略 |
| 不验证生成结果 | 直接复制 AI 生成的代码 | 先审查再集成,关键路径手动测试 |
10. 工作流集成
完整的 AI 编程工作流设计见 AI Coding工作流、前端AI Coding工作流、后端AI Coding工作流、iOS AI Coding工作流。以下是将 Prompt 模式嵌入工作流的关键节点:
需求阶段 → 架构设计 Prompt(4.4)→ 确认方案
开发阶段 → 代码生成 Prompt(4.1)→ 审查代码
调试阶段 → Debug Prompt(4.2)→ 验证修复
审查阶段 → 代码审查 Prompt(4.3)→ Review 报告
测试阶段 → 测试用例 Prompt(T4)→ 运行测试
文档阶段 → 代码文档 Prompt(T10)→ 更新文档11. 关联笔记
04_Prompts/ — Prompt 模板
- Prompt模板库:代码生成模板 — 可直接复用的代码生成模板
- Prompt模板库:代码审查模板 — 可直接复用的代码审查模板
- Prompt模板库:Debug 模板 — 可直接复用的 Debug 模板
- System Prompt设计:代码助手模板 — 完整的代码助手 System Prompt
- Cursor任务提示词模板 — Cursor Chat/Composer 三种轻量模板(修改/分析/Bug 修复)
- Cursor Rules模板 —
.cursorrules模板(通用/iOS/前端) - Cursor使用总览 — Cursor 提示词入口
- Claude Code任务提示词模板 — Claude Code 基础编码任务 + 分析任务模板
- Claude Code项目规则模板 — CLAUDE.md 模板
- Claude Code使用总览 — Claude Code 提示词入口
- Codex任务提示词模板 — Codex 基础 + 复杂任务 + 输出格式模板
- Codex代码修改提示词 — Codex 最小修改专用模板
- Codex重构提示词 — Codex 重构专用模板
- Codex排查问题提示词 — Codex Bug 排查专用模板
- Codex项目初始化提示词 — Codex 项目脚手架模板
- Codex项目规则模板 — Codex AGENTS.md 模板
- Codex使用总览 — Codex 提示词入口
- ChatGPT代码分析提示词 — ChatGPT 三种代码分析模板(解读/架构/性能)
04_Prompts/ — 编码工作流
- 代码审查工作流 — 五步标准化审查流程
- Bug排查工作流 — 六步 Bug 排查流程
- 需求分析工作流 — 五步需求拆分流程
- 部署排查工作流 — 五步部署排查流程
04_Prompts/ — Agent 规则模板
- 通用AGENTS模板 — 通用编码项目 AGENTS.md 模板
- 前端项目AGENTS模板 — 前端项目专用规则
- iOS项目AGENTS模板 — iOS 项目专用规则
- 全栈项目AGENTS模板 — 全栈项目专用规则
- 大型遗留项目AGENTS模板 — 遗留项目保守策略
- 代码审查模式 — 六维审查标准化模式
- Bug修复模式 — Bug 修复标准化模式
- 重构模式 — 重构标准化模式
- 根目录AGENTS示例 — PetPal 项目 AGENTS 完整示例
- 前端目录AGENTS示例 — 前端子目录 AGENTS 示例
- iOS目录AGENTS示例 — iOS 子目录 AGENTS 示例
- API目录AGENTS示例 — API 子目录 AGENTS 示例
- Nginx目录AGENTS示例 — Nginx 配置 AGENTS 示例
02_Domains/AI/07_AI_Coding/ — 编码工具规范与领域知识
- Claude Code使用规范 — Claude Code 工作流程和最佳实践
- Codex使用规范 — Codex CLI 工作流程和安全注意事项
- Cursor使用规范 — Cursor 操作方式和最佳实践
- Copilot使用规范 — GitHub Copilot 最佳实践
- Qoder使用规范 — Qoder 编码辅助规范
- Trae使用规范 — Trae Builder/Chat 模式说明
- AI编程工具总览 — 10 个工具的分类对比
- AI Coding工具对比 — 底层模型、功能、定价详细对比
- AI代码审查 — 审查流程和维度方法论
- AI重构工作流 — 重构五阶段方法论
- AI辅助Debug — Debug 方法论
- AI辅助架构设计 — 架构设计方法论
- AI生成测试 — 测试生成方法论
- AI生成文档 — 文档生成方法论
- AI Coding反模式 — 编码反模式总结
- Agent.md规范 — AGENTS.md 使用规范
- Rules规则文件管理 — 规则文件格式和继承策略
- Memory Layer设计 — 记忆层设计方法论
- Superpower使用边界 — Superpower 模式边界定义
- AI Coding工作流 — 整体编程工作流框架
- 前端AI Coding工作流 — 前端场景专用工作流
- 后端AI Coding工作流 — 后端场景专用工作流
- iOS AI Coding工作流 — iOS 场景专用工作流
03_Projects/ — 项目级规则
- PetPal AGENTS.md — PetPal iOS 项目 Agent 策略
- PetPal CLAUDE.md — PetPal Claude 补充规则
02_Domains/AI/03_Prompt_Engineering/ — 本模块相关
- 角色设定与任务设定 — 编程场景的角色和任务设计方法
- 输出格式控制 — 编程输出的格式控制技巧
- Prompt模板库 — 全场景 25 个模板索引
- System Prompt设计 — System Prompt 四要素设计方法论
- Prompt反模式 — Prompt 设计常见错误
外部工程参考
- 前端 Prompt Engineering 实现 — Prompt 编辑器前端实现参考(Monaco、多角色、模板系统)