提示示例
代码评审
架构评审
分析此代码库的架构:
1. 评估整体结构和模式
2. 识别潜在的架构问题
3. 提出改进可扩展性的建议
4. 标注遵循最佳实践的部分
重点关注可维护性和模块化。
安全性评审
对此代码库进行安全性评审:
1. 识别潜在的安全漏洞
2. 检查常见的安全反模式
3. 评审错误处理和输入验证
4. 评估依赖项的安全性
请提供具体示例和修复步骤。
性能评审
从性能角度评审代码库:
1. 识别性能瓶颈
2. 检查资源使用情况
3. 评审算法效率
4. 评估缓存策略
包含具体的优化建议。
文档生成
API 文档
生成全面的 API 文档:
1. 列出并描述所有公共端点
2. 记录请求/响应格式
3. 包含使用示例
4. 说明限制和约束
开发者指南
创建包含以下内容的开发者指南:
1. 环境搭建说明
2. 项目结构概览
3. 开发工作流程
4. 测试方法
5. 常见问题排查步骤
架构文档
记录系统架构:
1. 高层概述
2. 组件交互
3. 数据流程图
4. 设计决策及理由
5. 系统限制和约束
分析与改进
依赖项分析
分析项目依赖:
1. 识别过时的包
2. 检查安全漏洞
3. 建议替代包
4. 评审依赖使用模式
包含具体的升级建议。
测试覆盖率
评审测试覆盖率:
1. 识别未测试的组件
2. 建议额外的测试用例
3. 评审测试质量
4. 推荐测试策略
代码质量
评估代码质量并提出改进建议:
1. 评审命名规范
2. 检查代码组织
3. 评估错误处理
4. 评审注释实践
提供具体的良好和问题模式示例。
获得更好结果的技巧
- 明确具体:包含清晰的目标和评估标准
- 设置上下文:说明你的角色和所需的专业水平
- 请求格式:定义期望的响应结构
- 设置优先级:指出哪些方面最重要
模型特定说明
Claude
- 使用 XML 输出格式
- 将重要指令放在最后
- 指定响应结构
ChatGPT
- 使用 Markdown 格式
- 将大型代码库分成小节
- 包含系统角色提示
Gemini
- 适用于所有格式
- 每次请求专注于特定领域
- 使用逐步分析