Menu
代码规范评审。当用户需要检查代码是否符合编码规范、命名规范、代码格式，或询问"帮我做代码规范检查"、"评审这段代码"时使用。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Baseado na classificação ocupacional SOC
设计文档评审。当用户需要评审设计文档质量、检查设计合理性、发现设计缺陷，或询问"帮我评审设计文档"、"检查设计质量"时使用。
需求文档评审。当用户需要评审需求文档质量、检查需求完整性、发现需求缺陷，或询问"帮我评审需求文档"、"检查需求质量"时使用。
需求分析文档生成。当用户需要分析需求、生成需求规格说明书、需求文档，或询问“帮我分析这个需求”、“写需求文档”时使用。
现有项目技术架构分析。当用户需要分析老项目技术栈、接手新项目、技术调研，或询问"分析这个项目的技术架构"、"梳理技术栈"时使用。
数据库表结构导出。当用户需要导出数据库结构、生成表结构DDL，或询问"导出表结构"、"导出数据库DDL"时使用。
系统功能设计文档生成。当用户需要生成设计文档、系统设计、技术方案，或询问"帮我写设计文档"、"生成技术设计"时使用。
| name | review-coderule |
| description | 代码规范评审。当用户需要检查代码是否符合编码规范、命名规范、代码格式，或询问"帮我做代码规范检查"、"评审这段代码"时使用。 |
所有输出内容必须使用中文，包括评审报告、问题描述、改进建议、总体评价等。
根据指定的代码规范对代码进行评审，检查代码是否符合团队或项目的编码标准。
进行代码规范评审时，参考以下规范文件：
当用户提供代码规范文件路径和待评审代码时，执行规范检查并生成评审报告。
代码规范文件（必需）：
/projectdocs/sample/code_standard.md/projectdocs/sample/code_standard_template.md 模板编写自己的代码规范待评审代码：
/projectdocs/sample/code_standard.md 读取项目的代码规范# 代码规范评审报告
## 概览
- 评审文件：xxx.java
- 评审时间：2024-xx-xx
- 代码行数：xxx 行
- 规范符合度：xx%
- 问题总数：xx 个
## 评审结果
### 🔴 严重问题（x 个）
1. **[文件名:行号] 问题标题**
- 规范项：...
- 问题描述：...
- 当前代码：
```java
// 现有代码
// 符合规范的代码
...
...
...
## 评审清单
### 命名规范
- [ ] 类名是否符合规范
- [ ] 方法名是否符合规范
- [ ] 变量名是否符合规范
- [ ] 常量名是否符合规范
### 代码格式
- [ ] 缩进是否符合规范
- [ ] 空行使用是否合理
- [ ] 括号位置是否符合规范
- [ ] 行长度是否符合限制
### 注释规范
- [ ] 类注释是否完整
- [ ] 方法注释是否完整
- [ ] 关键代码是否有注释
- [ ] 注释格式是否符合规范
### 代码结构
- [ ] 类结构是否合理
- [ ] 方法顺序是否符合规范
- [ ] 包结构是否合理
- [ ] 导入语句是否规范
### 设计原则
- [ ] 是否遵循单一职责原则
- [ ] 是否遵循开闭原则
- [ ] 是否合理使用设计模式
- [ ] 代码是否易于扩展
## 注意事项
1. **代码规范文件必须**：必须先创建 `/projectdocs/sample/code_standard.md` 文件
2. **以规范为准**：严格按照规范文件中的标准进行评审
3. **具体明确**：问题描述要具体，标注文件名和行号
4. **提供示例**：每个问题都提供改进示例
5. **客观公正**：评审应该基于规范标准，而非个人喜好
6. **模板参考**：可以参考 `/projectdocs/sample/code_standard_template.md` 编写自己的规范