harries/hydpromptkit/review-coderule

代码规范评审

语言要求

所有输出内容必须使用中文，包括评审报告、问题描述、改进建议、总体评价等。

功能说明

根据指定的代码规范对代码进行评审，检查代码是否符合团队或项目的编码标准。

规范文件引用

进行代码规范评审时，参考以下规范文件：

• 代码规范模板：参考 examples/code_standard_template.md
• 项目代码规范（如已创建）：参考 /projectdocs/sample/code_standard.md

使用方式

当用户提供代码规范文件路径和待评审代码时，执行规范检查并生成评审报告。

输入要求

代码规范文件（必需）：

• 必须提供代码规范文件路径：/projectdocs/sample/code_standard.md
• 用户可以根据 /projectdocs/sample/code_standard_template.md 模板编写自己的代码规范
• 代码规范应包含：
• 命名规范
• 代码格式规范
• 注释规范
• 设计原则
• 最佳实践
• 禁止事项

待评审代码：

• 可以是单个文件
• 可以是多个文件
• 可以是整个模块

评审流程

1. 读取代码规范

• 从 /projectdocs/sample/code_standard.md 读取项目的代码规范
• 如果文件不存在，提示用户先创建代码规范文件
• 解析规范中的检查项

2. 代码检查

• 按照代码规范逐项检查
• 记录所有不符合规范的地方
• 标注具体的位置（文件名、行号）

3. 生成报告

• 列出所有不符合规范的问题
• 提供改进建议和示例代码
• 给出符合性评分

问题等级

🔴 严重问题（Critical）

• 严重违反代码规范
• 影响系统稳定性
• 导致安全风险

🟠 重要问题（Major）

• 明显违反命名规范
• 代码结构问题
• 影响可维护性

🟡 一般问题（Normal）

• 注释不规范
• 格式问题
• 命名不统一

🟢 建议优化（Minor）

• 可读性优化
• 代码风格统一
• 最佳实践建议

评审报告格式

# 代码规范评审报告
 
## 概览
-评审文件：xxx.java
-评审时间：2024-xx-xx
-代码行数：xxx 行
-规范符合度：xx%
-问题总数：xx 个
 
## 评审结果
 
### 🔴 严重问题（x 个）
1.**[文件名:行号] 问题标题**
   -规范项：...
   -问题描述：...
   -当前代码：
   ```java
   // 现有代码
   ```
   -改进建议：
   ```java
   // 符合规范的代码
   ```
 
### 🟠 重要问题（x 个）
...
 
### 🟡 一般问题（x 个）
...
 
### 🟢 建议优化（x 个）
...
 
## 总体评价
-规范符合度：xx%
-主要优点：...
-主要问题：...
-改进建议：...

评审清单

命名规范

• [ ] 类名是否符合规范
• [ ] 方法名是否符合规范
• [ ] 变量名是否符合规范
• [ ] 常量名是否符合规范

代码格式

• [ ] 缩进是否符合规范
• [ ] 空行使用是否合理
• [ ] 括号位置是否符合规范
• [ ] 行长度是否符合限制

注释规范

• [ ] 类注释是否完整
• [ ] 方法注释是否完整
• [ ] 关键代码是否有注释
• [ ] 注释格式是否符合规范

代码结构

• [ ] 类结构是否合理
• [ ] 方法顺序是否符合规范
• [ ] 包结构是否合理
• [ ] 导入语句是否规范

设计原则

• [ ] 是否遵循单一职责原则
• [ ] 是否遵循开闭原则
• [ ] 是否合理使用设计模式
• [ ] 代码是否易于扩展

注意事项

1. 代码规范文件必须：必须先创建 /projectdocs/sample/code_standard.md 文件
2. 以规范为准：严格按照规范文件中的标准进行评审
3. 具体明确：问题描述要具体，标注文件名和行号
4. 提供示例：每个问题都提供改进示例
5. 客观公正：评审应该基于规范标准，而非个人喜好
6. 模板参考：可以参考 /projectdocs/sample/code_standard_template.md 编写自己的规范