273 lines
3.8 KiB
Markdown
273 lines
3.8 KiB
Markdown
# 代码审查提示词
|
||
|
||
> 让 AI 帮你进行专业的代码审查
|
||
|
||
---
|
||
|
||
## 🔍 通用代码审查
|
||
|
||
```
|
||
请对以下代码进行全面的代码审查：
|
||
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
|
||
请从以下维度进行审查：
|
||
|
||
1. **代码质量**
|
||
- 可读性
|
||
- 命名规范
|
||
- 代码结构
|
||
|
||
2. **潜在问题**
|
||
- Bug 风险
|
||
- 边界情况
|
||
- 异常处理
|
||
|
||
3. **性能**
|
||
- 时间复杂度
|
||
- 空间复杂度
|
||
- 优化建议
|
||
|
||
4. **安全性**
|
||
- 输入验证
|
||
- 敏感数据处理
|
||
- 常见漏洞
|
||
|
||
5. **最佳实践**
|
||
- 设计模式
|
||
- SOLID 原则
|
||
- 语言特性使用
|
||
|
||
请按严重程度（🔴 严重 / 🟡 建议 / 🟢 优化）标注每个问题，并提供修改建议。
|
||
```
|
||
|
||
---
|
||
|
||
## 📋 快速审查（简化版）
|
||
|
||
```
|
||
快速审查这段代码，只关注：
|
||
1. 明显的 Bug
|
||
2. 安全问题
|
||
3. 性能问题
|
||
|
||
代码：
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
|
||
直接列出问题和修复方案，不需要详细解释。
|
||
```
|
||
|
||
---
|
||
|
||
## 🎯 特定维度审查
|
||
|
||
### 安全审查
|
||
|
||
```
|
||
请对这段代码进行安全审查：
|
||
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
|
||
重点检查：
|
||
- SQL 注入
|
||
- XSS 攻击
|
||
- CSRF 漏洞
|
||
- 敏感信息泄露
|
||
- 权限控制
|
||
- 输入验证
|
||
|
||
列出所有安全风险并提供修复代码。
|
||
```
|
||
|
||
### 性能审查
|
||
|
||
```
|
||
请对这段代码进行性能审查：
|
||
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
|
||
分析：
|
||
1. 时间复杂度
|
||
2. 空间复杂度
|
||
3. 数据库查询效率（如适用）
|
||
4. 内存使用
|
||
5. 并发处理
|
||
|
||
提供优化后的代码和性能对比。
|
||
```
|
||
|
||
### 可维护性审查
|
||
|
||
```
|
||
请从可维护性角度审查这段代码：
|
||
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
|
||
评估：
|
||
1. 代码是否易于理解
|
||
2. 是否遵循单一职责原则
|
||
3. 是否有适当的注释
|
||
4. 是否易于测试
|
||
5. 是否易于扩展
|
||
|
||
提供重构建议。
|
||
```
|
||
|
||
---
|
||
|
||
## 🔄 PR 审查模板
|
||
|
||
```
|
||
请帮我审查这个 Pull Request：
|
||
|
||
## 变更描述
|
||
[描述这个 PR 做了什么]
|
||
|
||
## 变更的文件
|
||
|
||
### 文件 1: [文件名]
|
||
```
|
||
[粘贴代码变更]
|
||
```
|
||
|
||
### 文件 2: [文件名]
|
||
```
|
||
[粘贴代码变更]
|
||
```
|
||
|
||
请：
|
||
1. 检查代码质量
|
||
2. 验证逻辑正确性
|
||
3. 确认是否有遗漏的边界情况
|
||
4. 检查是否需要添加测试
|
||
5. 给出 Approve / Request Changes / Comment 建议
|
||
```
|
||
|
||
---
|
||
|
||
## 📊 审查报告模板
|
||
|
||
```
|
||
请生成一份代码审查报告：
|
||
|
||
代码：
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
|
||
报告格式：
|
||
|
||
# 代码审查报告
|
||
|
||
## 概述
|
||
- 代码行数：
|
||
- 审查时间：
|
||
- 整体评分：X/10
|
||
|
||
## 问题汇总
|
||
| 严重程度 | 数量 |
|
||
|---------|------|
|
||
| 🔴 严重 | X |
|
||
| 🟡 建议 | X |
|
||
| 🟢 优化 | X |
|
||
|
||
## 详细问题
|
||
|
||
### 🔴 严重问题
|
||
1. [问题描述]
|
||
- 位置：第 X 行
|
||
- 原因：
|
||
- 修复：
|
||
|
||
### 🟡 建议改进
|
||
...
|
||
|
||
### 🟢 优化建议
|
||
...
|
||
|
||
## 总结与建议
|
||
```
|
||
|
||
---
|
||
|
||
## 🆚 代码对比审查
|
||
|
||
```
|
||
请对比审查这两个版本的代码：
|
||
|
||
## 原版本
|
||
```
|
||
[粘贴原代码]
|
||
```
|
||
|
||
## 新版本
|
||
```
|
||
[粘贴新代码]
|
||
```
|
||
|
||
请分析：
|
||
1. 新版本解决了什么问题
|
||
2. 新版本是否引入了新问题
|
||
3. 新版本的改进是否合理
|
||
4. 是否有更好的实现方式
|
||
```
|
||
|
||
---
|
||
|
||
## 💡 审查技巧
|
||
|
||
### 审查清单
|
||
|
||
```
|
||
请按照以下清单审查代码：
|
||
|
||
- [ ] 代码能正常运行
|
||
- [ ] 没有明显的 Bug
|
||
- [ ] 错误处理完善
|
||
- [ ] 没有安全漏洞
|
||
- [ ] 性能可接受
|
||
- [ ] 代码可读性好
|
||
- [ ] 有必要的注释
|
||
- [ ] 遵循项目规范
|
||
- [ ] 有对应的测试
|
||
|
||
代码：
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
```
|
||
|
||
### 学习式审查
|
||
|
||
```
|
||
请审查这段代码，并教我：
|
||
1. 这段代码做了什么
|
||
2. 有哪些值得学习的地方
|
||
3. 有哪些可以改进的地方
|
||
4. 相关的最佳实践是什么
|
||
|
||
代码：
|
||
```
|
||
[粘贴代码]
|
||
```
|
||
```
|
||
|
||
---
|
||
|
||
## 使用建议
|
||
|
||
1. **提供上下文** - 说明代码的用途和背景
|
||
2. **指定重点** - 如果只关心某个方面，明确说明
|
||
3. **分批审查** - 代码太长时分文件审查
|
||
4. **跟进修复** - 审查后让 AI 帮你修复问题
|