AI 提示词教程
编程开发提示词
专业编程开发场景的 AI 提示词模板和技巧
编程开发提示词
本章提供专业编程开发场景的 AI 提示词模板,帮助程序员提升开发效率,涵盖代码生成、调试、重构、文档编写等各个环节。
适用人群:程序员、软件工程师、计算机专业学生、技术负责人
涵盖技能:代码编写、代码审查、架构设计、技术文档、问题调试
🚀 代码生成类提示词
基础代码生成
我需要用 Python 编写一个 [具体功能描述]。
**需求详情**:
- 功能:[详细描述要实现的功能]
- 输入:[输入参数说明]
- 输出:[期望的输出格式]
- 约束条件:[性能要求、兼容性等]
**代码要求**:
- 遵循 PEP 8 编码规范
- 添加详细的中文注释
- 包含错误处理机制
- 提供使用示例
请生成完整的代码实现。我需要用 JavaScript 编写一个 [具体功能描述]。
**项目环境**:
- 运行环境:[Node.js/浏览器/React/Vue 等]
- 版本要求:[ES6+/TypeScript 等]
- 依赖库:[如果有特定依赖请说明]
**功能需求**:
- 核心功能:[详细描述]
- 输入输出:[参数和返回值说明]
- 兼容性:[浏览器兼容性要求]
**代码标准**:
- 使用现代 JavaScript 语法
- 添加 JSDoc 注释
- 包含错误处理
- 提供测试用例
请提供完整实现。我需要用 Java 编写一个 [具体功能描述]。
**技术栈**:
- Java 版本:[Java 8/11/17 等]
- 框架:[Spring Boot/Spring MVC 等,如适用]
- 构建工具:[Maven/Gradle]
**设计要求**:
- 功能:[详细需求描述]
- 设计模式:[如果需要特定设计模式]
- 性能要求:[响应时间、并发量等]
**编码规范**:
- 遵循 Java 编码规范
- 添加完整的 Javadoc 注释
- 实现适当的异常处理
- 编写单元测试
请提供完整的类设计和实现。我需要编写一个 [编程语言] 程序来实现 [功能描述]。
**项目背景**:
[简要说明项目或业务背景]
**具体需求**:
1. 核心功能:[详细描述主要功能]
2. 输入数据:[输入参数、数据格式等]
3. 输出结果:[期望的输出格式和内容]
4. 性能要求:[速度、内存使用等要求]
5. 兼容性:[版本、平台兼容性]
**技术要求**:
- 代码风格:遵循该语言的最佳实践
- 注释:添加详细的中文注释
- 错误处理:包含完善的异常处理机制
- 测试:提供使用示例或测试用例
请提供完整的代码实现和说明。算法实现提示词
我需要实现 [算法名称] 算法。
**算法要求**:
- 算法类型:[排序/搜索/动态规划/图论等]
- 时间复杂度要求:[O(n)/O(log n) 等]
- 空间复杂度要求:[如果有限制]
- 编程语言:[指定语言]
**具体需求**:
- 输入:[数据结构和范围]
- 输出:[结果格式]
- 边界条件:[需要处理的特殊情况]
**代码要求**:
1. 提供清晰的算法思路说明
2. 逐步实现,包含详细注释
3. 分析时间和空间复杂度
4. 提供测试用例和预期结果
5. 如果有多种实现方法,请对比说明
请先解释算法原理,再提供代码实现。🔧 代码优化与重构
代码审查提示词
请帮我审查以下代码,并提供改进建议:
[在这里粘贴需要审查的代码]
**审查重点**:
- 代码质量:可读性、可维护性
- 性能优化:算法效率、资源使用
- 安全性:潜在的安全漏洞
- 最佳实践:是否遵循编程规范
- 错误处理:异常情况的处理
**期望输出**:
1. 发现的问题列表(按优先级排序)
2. 具体的改进建议
3. 重构后的代码示例(针对关键问题)
4. 总体评价和建议
请详细分析并提供可执行的改进方案。性能优化提示词
我的代码性能不够理想,需要优化建议:
**当前代码**:
[在这里粘贴需要优化的代码]
**性能问题**:
- 具体表现:[响应慢/内存占用高/CPU使用率高等]
- 运行环境:[硬件配置、数据量级等]
- 性能指标:[当前性能数据,如响应时间]
- 目标要求:[期望达到的性能水平]
**优化方向**:
1. 算法优化:提供更高效的算法
2. 数据结构优化:选择更合适的数据结构
3. 内存优化:减少内存使用和垃圾回收
4. 并发优化:充分利用多核性能
5. 缓存策略:合理使用缓存机制
请提供优化方案、改进后的代码和预期性能提升。📚 文档与注释
API 文档生成
请为以下代码生成完整的 API 文档:
[在这里粘贴需要生成文档的代码]
**文档要求**:
- 文档格式:[Markdown/JSDoc/Javadoc/Sphinx等]
- 包含内容:
1. 功能概述和用途说明
2. 参数详细描述(类型、必填性、默认值)
3. 返回值说明(类型、格式、示例)
4. 使用示例和代码演示
5. 异常情况和错误处理
6. 注意事项和最佳实践
**文档风格**:
- 语言:中文
- 风格:清晰易懂,适合团队使用
- 示例:提供实际可运行的代码示例
请生成专业的 API 文档。代码注释优化
请为以下代码添加详细的中文注释:
[在这里粘贴需要添加注释的代码]
**注释要求**:
1. **文件级注释**:文件用途、作者、创建时间
2. **类/函数注释**:功能说明、参数描述、返回值
3. **行内注释**:复杂逻辑的解释说明
4. **算法注释**:关键算法步骤的详细说明
**注释标准**:
- 使用该语言的标准注释格式
- 注释内容准确、简洁、有用
- 避免显而易见的注释
- 重点解释"为什么"而不是"是什么"
请保持原有代码不变,只添加高质量的注释。🐛 调试与问题解决
Bug 分析提示词
我遇到了一个程序 Bug,需要帮助分析和解决:
**Bug 现象**:
[详细描述 Bug 的表现,包括错误信息]
**出错代码**:
[在这里粘贴相关的代码片段]
**运行环境**:
- 编程语言版本:[版本号]
- 操作系统:[Windows/macOS/Linux]
- 相关依赖:[重要的依赖库及版本]
**重现步骤**:
1. [步骤一]
2. [步骤二]
3. [导致错误的具体步骤]
**期望结果**:
[描述期望的正确行为]
**分析要求**:
1. 根因分析:找出 Bug 的根本原因
2. 解决方案:提供修复代码
3. 预防措施:避免类似问题的建议
4. 测试建议:如何验证修复效果
请提供详细的分析和解决方案。错误信息解读
我收到了以下错误信息,请帮我分析和解决:
**错误信息**:[完整的错误信息和堆栈跟踪]
**相关代码**:
[在这里粘贴出现错误的代码]
**执行环境**:
- 编程语言:[语言和版本]
- 开发环境:[IDE/编辑器]
- 运行环境:[本地/服务器等]
**分析需求**:
1. **错误解读**:用通俗的语言解释错误含义
2. **原因分析**:分析导致错误的可能原因
3. **解决方案**:提供具体的修复步骤
4. **代码示例**:给出修改后的正确代码
5. **预防建议**:如何避免类似错误
请提供清晰的分析和解决方案。🏗️ 架构设计
系统架构设计
我需要设计一个 [系统类型] 的技术架构:
**项目需求**:
- 项目类型:[Web应用/移动应用/微服务/数据平台等]
- 用户规模:[预估用户数量和并发量]
- 主要功能:[核心功能模块列表]
- 性能要求:[响应时间、吞吐量等指标]
- 可用性要求:[可用性等级,如99.9%]
**技术约束**:
- 技术栈偏好:[编程语言、框架偏好]
- 部署环境:[云平台/自建机房等]
- 预算考虑:[成本敏感度]
- 团队技能:[团队的技术储备]
**设计要求**:
1. **整体架构图**:系统组件和交互关系
2. **技术选型**:各层技术栈选择和理由
3. **数据流设计**:数据处理流程
4. **部署架构**:部署策略和环境规划
5. **扩展性考虑**:如何应对业务增长
6. **安全方案**:安全架构和防护措施
请提供完整的架构设计方案。数据库设计
请帮我设计一个 [业务场景] 的数据库schema:
**业务需求**:
- 业务领域:[电商/社交/内容管理等]
- 核心实体:[主要业务对象]
- 业务流程:[关键业务流程描述]
- 数据规模:[预估数据量和增长速度]
**技术要求**:
- 数据库类型:[MySQL/PostgreSQL/MongoDB等]
- 性能要求:[查询性能、写入性能]
- 一致性要求:[强一致性/最终一致性]
- 备份恢复:[数据安全要求]
**设计输出**:
1. **ER 图**:实体关系图
2. **表结构**:详细的表定义(SQL)
3. **索引设计**:关键索引策略
4. **分库分表**:如果需要的话
5. **查询优化**:典型查询的优化建议
6. **维护方案**:数据维护和监控策略
请提供完整的数据库设计方案。💡 实用开发技巧
代码模板生成
设计模式实现
快速生成常用设计模式的代码模板
项目脚手架
创建项目初始结构和配置文件
单元测试模板
生成完整的单元测试代码
CI/CD 配置
自动化部署和持续集成配置
设计模式生成提示词
我需要实现 [设计模式名称] 设计模式:
**应用场景**:
[描述要解决的具体问题和业务场景]
**技术要求**:
- 编程语言:[Java/Python/JavaScript等]
- 框架环境:[如果有特定框架要求]
- 复杂程度:[简单示例/生产级代码]
**实现要求**:
1. **模式说明**:解释该设计模式的用途和适用场景
2. **UML 图**:提供类图(用文本描述)
3. **代码实现**:完整的代码示例
4. **使用示例**:演示如何使用
5. **优缺点分析**:分析该模式的利弊
6. **相关模式**:推荐相关的设计模式
请提供完整的设计模式实现和说明。单元测试生成
请为以下代码生成完整的单元测试:
**被测试代码**:
[在这里粘贴需要测试的代码]
**测试要求**:
- 测试框架:[JUnit/pytest/Jest等]
- 覆盖率要求:[尽可能高的代码覆盖率]
- 测试类型:[单元测试/集成测试]
**测试内容**:
1. **正常流程测试**:各种正常输入的测试用例
2. **边界条件测试**:边界值和临界情况
3. **异常情况测试**:错误输入和异常处理
4. **性能测试**:如果适用的话
5. **Mock 对象**:外部依赖的模拟
**输出格式**:
- 完整的测试类代码
- 测试用例说明
- 运行和验证指导
请生成专业的单元测试代码。🔗 集成与部署
API 接口设计
我需要设计一套 [业务领域] 的 RESTful API:
**业务需求**:
- 功能模块:[列出主要功能模块]
- 用户角色:[不同的用户类型和权限]
- 操作类型:[CRUD操作的具体需求]
**技术规范**:
- API 风格:RESTful
- 数据格式:JSON
- 认证方式:[JWT/OAuth2等]
- 版本控制:[版本管理策略]
**设计输出**:
1. **API 清单**:所有接口的列表
2. **接口详情**:每个接口的详细定义
- HTTP 方法和路径
- 请求参数和格式
- 响应数据和状态码
- 错误处理
3. **认证授权**:安全机制设计
4. **API 文档**:完整的文档示例
5. **测试用例**:接口测试示例
请提供完整的 API 设计方案。部署脚本生成
我需要为 [项目类型] 创建部署脚本:
**项目信息**:
- 技术栈:[编程语言、框架、数据库]
- 部署环境:[Linux/Windows/Docker/云平台]
- 项目结构:[简要描述项目组织结构]
**部署需求**:
- 部署步骤:[构建、测试、部署的流程]
- 环境配置:[开发、测试、生产环境]
- 依赖管理:[如何处理项目依赖]
- 数据迁移:[数据库迁移脚本]
- 监控日志:[监控和日志配置]
**脚本类型**:
- Shell 脚本(Linux/macOS)
- 批处理脚本(Windows)
- Docker 配置
- CI/CD 流水线配置
**输出内容**:
1. 完整的部署脚本
2. 配置文件模板
3. 部署文档和说明
4. 故障排除指南
请提供完整的部署解决方案。📋 最佳实践总结
代码质量检查清单
编程提示词最佳实践
✅ 需求明确:详细描述功能需求和技术约束
✅ 技术栈指定:明确编程语言、框架和版本
✅ 代码规范:要求遵循编码标准和最佳实践
✅ 完整性:包含注释、错误处理、测试用例
✅ 示例丰富:提供具体的使用场景和示例
✅ 性能考虑:关注算法复杂度和性能优化
常见问题解决
问题:生成的代码质量不高
- 解决:提供更详细的需求和约束条件
- 技巧:明确编码规范和质量要求
问题:代码不符合项目架构
- 解决:描述现有架构和设计模式
- 技巧:提供项目背景和技术栈信息
问题:难以定位 Bug 原因
- 解决:提供完整的错误信息和执行环境
- 技巧:按步骤重现问题
问题:性能问题难以解决
- 解决:提供性能数据和瓶颈分析
- 技巧:使用专业的性能分析工具
原则:先测量,后优化
- 使用性能分析工具找出瓶颈
- 关注关键路径的优化
策略:算法 > 数据结构 > 细节优化
- 首先考虑算法复杂度
- 然后优化数据结构选择
- 最后进行细节调优
代码规范:统一团队编码标准
- 制定并执行代码规范
- 使用代码检查工具
文档维护:保持文档同步更新
- API 文档自动化生成
- 定期更新技术文档