附录B: 企业开发规范 Prompt 集合
本附录提供了一系列即用型Prompt,旨在将企业级开发规范和最佳实践融入日常的AI协作开发流程中。
1. Prompt:生成符合规范的模块代码
场景: 当我们需要创建新的功能模块时,可以与AI协作来确保代码既符合团队技术规范,又能从AI的不同视角中获得优化建议。
text
作为我们的开发伙伴,请使用以下技术栈和规范,与我们一起协作创建一个新的功能模块。
**项目背景:**
- **项目名称**: [项目名称]
- **核心目标**: [项目核心目标]
- **技术栈**: Go, Gin, GORM, PostgreSQL
**任务要求:**
1. **功能**: 创建一个完整的“用户管理”模块,包括用户的增、删、改、查(CRUD)功能。
2. **API设计**:
- 设计RESTful API,遵循OpenAPI 3.0规范。
- `POST /users`: 创建用户
- `GET /users`: 获取用户列表(支持分页)
- `GET /users/{id}`: 获取单个用户
- `PUT /users/{id}`: 更新用户
- `DELETE /users/{id}`: 删除用户
3. **代码结构**:
- 在 `internal/` 目录下创建 `user` 模块。
- 遵循分层架构:`handler` (处理HTTP请求), `service` (处理业务逻辑), `repository` (处理数据持久化)。
4. **数据模型**:
- 用户模型应包含 `ID`, `Username`, `Email`, `CreatedAt`, `UpdatedAt` 字段。
- 使用GORM进行数据库迁移和操作。
5. **错误处理**:
- 实现统一的错误处理中间件。
- API返回的错误信息应包含明确的错误码和描述。
6. **日志**:
- 在关键操作(如创建、删除用户)处添加结构化日志(使用`slog`库)。
7. **测试**:
- 为Service层编写单元测试,覆盖核心业务逻辑。
请首先提供代码结构(目录树),然后分文件提供完整的代码实现。2. Prompt:执行AI代码审查 (AI Code Review)
场景: 在提交代码合并请求(Pull Request)之前,让AI扮演资深架构师的角色,对你的代码进行一次全面的审查。
text
我将提供给你一段我刚完成的代码,请你扮演一名经验丰富的软件架构师,根据我们团队的开发规范,对代码进行一次严格的Code Review。
**团队规范:**
- **语言**: [Go / Python / TypeScript]
- **核心原则**: SOLID原则,KISS (Keep It Simple, Stupid), DRY (Don't Repeat Yourself)。
- **性能**: 关注潜在的性能瓶颈,如不合理的循环、数据库N+1查询等。
- **安全**: 检查是否存在常见的安全漏洞,如SQL注入、跨站脚本(XSS)、不安全的输入处理等。
- **可读性**: 代码是否易于理解?命名是否清晰?注释是否必要且充分?
- **错误处理**: 错误是否被妥善处理?是否存在被忽略的错误?
**审查流程:**
1. **总体评价**: 首先,对代码的整体设计和实现给出一个总体评价。
2. **具体问题**: 然后,逐行或逐个函数地指出具体问题,并以表格形式呈现。表格应包含三列:**文件名和行号**、**问题描述**、**修改建议**。
3. **总结**: 最后,总结代码中值得称赞的优点和最需要改进的关键点。
---
**[在这里粘贴你的代码]**
---