Sky-Cube 编码规范检查Skill
适用场景
代码审查环节,逐项核对代码是否符合全局编码规范(CLAUDE.md 与项目约定)。
执行步骤
- 读取规范基线:全局 CLAUDE.md 编码强制规范 + 项目内约定。
- 逐项核对:命名规范 → 代码格式 → 注释规范 → 分层结构 → 文件头。
- 每个违规项定位:文件 + 行号 + 违规内容 + 对应规范条款。
- 输出判定:合规 / 违规清单。
核对清单
| 检查项 | 规范要求 |
|---|---|
| 变量/方法命名 | camelCase,见名知意,禁止 a/b/tmp |
| 类/接口命名 | PascalCase |
| 常量/枚举 | UPPER_SNAKE_CASE |
| 文件名 | kebab-case,禁止中文与空格 |
| DB 表/字段 | snake_case |
| 缩进 | 4 空格,全项目统一 |
| 大括号 | 风格统一不混用 |
| 注释 | 类/核心函数有文档注释;复杂逻辑有说明;无废话注释 |
| 文件头 | 含文件说明/作者/创建日期(按项目约定) |
| 分层 | Controller/Service/DAO 职责分离,无跨层直调 |
| 魔法值 | 禁止魔法数字/字符串,统一常量 |
| 嵌套 | 超 3 层必须重构 |
| 未用项 | 无无效导入、未使用变量 |
规范要点
- 违规必须给条款依据,禁止凭个人偏好提意见(风格之争以项目现状为准)。
- 只报告违规事实,不顺手改代码。
输出模板
| # | 位置 | 违规内容 | 规范条款 | 级别 |
自检清单
- 每条违规有位置与条款依据
- 风格类意见单独列「建议」区,不与违规混列