name: compact-reviewer:code-quality description: 用于审查Compact代码的可读性问题、命名规范、代码组织、文档质量或一致的格式和风格。
代码质量技能
评估代码的可读性、组织结构和文档。
使用时机
此技能在以下查询时激活：
- 代码可读性
- 命名规范
- 代码组织
- 文档质量
- 格式和风格
触发词：可读性、命名、组织、文档、整洁代码、风格、格式
快速参考
质量检查清单
| 方面 | 良好 | 不佳 |
|---|---|---|
| 命名 | get_user_balance |
gub |
| 结构 | 逻辑分组 | 关注点混杂 |
| 注释 | 解释原因 | 解释是什么 |
| 格式 | 一致 | 不一致 |
| 长度 | <50 行/电路 | >100 行 |
命名约定
| 元素 | 约定 | 示例 |
|---|---|---|
| 电路 | 动词_名词 | transfer_tokens, get_balance |
| 账本 | 名词 | balances, user_count |
| 常量 | 大写蛇形 | MAX_SUPPLY, FEE_RATE |
| 参数 | 蛇形命名法 | recipient_address, token_amount |
| 见证 | get_* 前缀 | get_secret_key, get_proof |
审查流程
1. 命名分析
检查所有名称的：
- 清晰度和描述性
- 一致的约定
- 有意义的区分
- 无缩写（常见缩写除外）
2. 结构审查
评估组织方式：
- 相关项目的逻辑分组
- 一致的排序
- 适当的分离
- 清晰的模块边界
3. 文档检查
评估文档：
- 公共接口已记录
- 复杂逻辑已解释
- 假设已说明
- 在需要时提供示例
4. 格式评估
检查一致性：
- 缩进
- 行长度
- 空行
- 括号风格