name: 紧凑型代码可维护性审查 reviewer: 维护者 description: 用于审查紧凑型合约的长期可维护性,识别技术债务,规划升级策略,或评估模块化与重构需求。
可维护性技能
评估长期可维护性并识别技术债务。
使用时机
此技能在以下查询时激活:
- 长期维护
- 技术债务
- 升级策略
- 模块化
- 未来变更
触发词:可维护性、技术债务、升级、模块化、重构、未来验证
快速参考
可维护性因素
| 因素 | 良好 | 不佳 |
|---|---|---|
| 模块化 | 关注点分离 | 单体式 |
| 耦合度 | 松散 | 紧密 |
| 文档 | 最新 | 缺失/过时 |
| 依赖项 | 最少 | 过多 |
| 复杂度 | 低 | 高 |
技术债务指标
- 大型电路(>50行)
- 重复代码
- 魔法数字
- 缺失文档
- 复杂嵌套
- 不清晰的命名
审查流程
1. 模块化评估
评估代码分离情况:
- 每个电路单一职责
- 清晰的模块边界
- 最少的交叉依赖
2. 变更影响分析
考虑未来变更:
- 添加功能有多难?
- 修改行为有多难?
- 如果X变更,什么会出问题?
3. 债务识别
寻找:
- TODO和FIXME注释
- 注释掉的代码
- 变通方案
- 已弃用的模式
4. 升级准备度检查
检查:
- 版本处理
- 迁移路径
- 向后兼容性