高效生成代码的专业提示词模板,从基本结构到特定功能实现与测试
使用我们的代码生成模板,大幅提高编码效率并确保代码质量。这些模板帮助你利用 AI 生成高质量的代码,从基本结构到特定功能实现与测试。
这些模板特别适合开发人员、QA工程师和DevOps工程师使用,加速编码过程,确保生成的代码符合最佳实践和项目标准。
生成项目的基本代码结构模板,包括目录结构、核心文件和配置设置。
# 基本代码结构生成模板 ## 前提条件 - 项目名称: [项目名称] - 项目类型: [Web应用/移动应用/API服务/命令行工具等] - 编程语言: [主要编程语言] - 框架: [使用的框架,如React/Express/Django等] - 构建工具: [如npm/gradle/maven等] ## 需求描述要点 - 项目概述: * 项目的主要功能和目的 * 技术栈选择理由 * 核心功能模块 - 目录结构: * 完整的目录布局 * 每个目录的用途说明 * 遵循的目录组织模式(如MVC/Clean Architecture等) - 核心文件: * 主要配置文件 * 入口文件 * 核心模块文件 * 示例组件或类 - 依赖管理: * 主要依赖项及版本 * 依赖项的用途说明 * 开发和生产环境依赖分离 - 基础配置: * 环境配置 * 构建配置 * 测试配置 * 代码规范配置 ## 输出格式 - 格式: 详细的目录树结构,配置文件代码和核心文件代码 - 注释: 在关键文件和目录上添加说明注释 - 示例: 提供关键文件的实际代码示例 ## 其他要求 - 确保符合语言和框架的最佳实践 - 包含README文件,说明项目设置和运行方法 - 考虑可扩展性和可维护性 - 提供版本控制忽略文件(.gitignore等)
根据功能需求生成完整模块代码,包括业务逻辑、数据验证和错误处理。
# 功能模块实现生成模板 ## 前提条件 - 功能名称: [功能名称] - 编程语言: [编程语言] - 框架: [使用的框架,如有] - 所属系统: [更大系统的上下文] - 依赖模块: [依赖的其他模块或服务] ## 需求描述要点 - 功能概述: * 功能的目的和作用 * 输入和预期输出 * 与其他功能的交互 - 详细功能需求: * 完整的功能流程 * 包含的子功能 * 业务规则和约束 * 边缘情况处理 - 技术实现细节: * 数据结构设计 * 算法选择 * 接口定义 * 状态管理 - 数据验证需求: * 输入验证规则 * 数据格式和类型检查 * 安全考虑 - 错误处理策略: * 可能发生的错误情况 * 错误处理方法 * 日志记录需求 * 用户反馈机制 ## 输出格式 - 格式: 完整的源代码文件 - 文档: 包含详细的代码注释 - 示例: 包含使用示例 ## 其他要求 - 代码应遵循项目的代码规范 - 确保代码的可测试性 - 考虑性能优化 - 关注代码的可维护性和可扩展性
为现有代码生成单元测试,确保覆盖正常流程和边缘情况。
# 单元测试生成模板 ## 前提条件 - 待测试代码: [插入要测试的代码或描述功能] - 编程语言: [编程语言] - 测试框架: [测试框架,如Jest/JUnit/pytest等] - 代码依赖: [代码依赖的外部服务或模块] ## 需求描述要点 - 测试策略: * 测试目标和范围 * 测试优先级 * 测试覆盖率目标 - 测试场景: * 正常流程测试 * 边缘情况测试 * 异常情况测试 * 性能临界值测试(如适用) - 模拟和存根: * 需要模拟的外部依赖 * 模拟对象的行为定义 * 测试数据准备 - 测试结构: * 测试套件组织 * 测试用例分组 * 共享测试夹具设置 - 断言和验证: * 关键验证点 * 期望结果的详细说明 ## 输出格式 - 格式: 完整可执行的测试代码 - 注释: 说明每个测试用例的目的 - 组织: 清晰的测试分组和命名 ## 其他要求 - 确保测试的独立性 - 考虑测试执行效率 - 使用测试框架的最佳实践 - 包含测试运行和覆盖率检查的说明
根据API规范生成服务器端端点代码,处理请求、验证输入和生成响应。
# API 端点实现生成模板 ## 前提条件 - API 端点: [端点路径和HTTP方法,如 GET /api/users] - 编程语言: [后端编程语言] - 框架: [使用的后端框架,如Express/Flask/Spring Boot等] - 数据库: [使用的数据库类型,如适用] - 认证要求: [认证方式,如JWT/OAuth等] ## 需求描述要点 - 端点功能: * 端点的主要功能和目的 * 业务规则和限制 * 预期的使用场景 - 请求详情: * URL参数定义 * 查询参数定义 * 请求体结构和字段说明 * 请求头要求 - 输入验证: * 必填字段验证 * 数据类型和格式验证 * 业务规则验证 * 安全验证(如防止注入) - 处理逻辑: * 业务逻辑实现 * 数据访问方法 * 外部服务调用 * 事务管理(如适用) - 响应设计: * 成功响应结构 * 错误响应结构 * HTTP状态码使用 * 响应头设置 - 错误处理: * 可能的错误情况 * 异常捕获和处理 * 错误消息和代码 ## 输出格式 - 格式: 完整的端点实现代码 - 注释: 包含代码注释和文档字符串 - 示例: 提供请求和响应示例 ## 其他要求 - 遵循RESTful设计最佳实践 - 考虑端点的性能和可伸缩性 - 实现适当的日志记录 - 考虑API版本控制