SuperAPI AI 工具集

code-quality-principles

编程与开发

查看项目

更新于 10-15 17:20

技能介绍

用途:在重构或评审代码时,应用 KISS、YAGNI 与 SOLID 原则,降低复杂度、提升可读性与可维护性。适用于改善可读性、在重构中落实这些原则;不适用于一次性脚本、一次性数据迁移,或可读性让步合理的性能关键代码。

主要能力: KISS:避免不必要复杂度,偏好简单条件、显式代码、标准模式与直接方案,避免为简单检查写复杂正则、魔法数字、取巧捷径与过度抽象层。含 Python、Rust 正反示例。 YAGNI:只解决当前问题,不构建假设性未来功能;在第 3 个用例出现时再抽象;删除死代码;保持最小可行方案,避免过早优化。含 Python、TypeScript 示例。 SOLID:单一职责(一个变化原因)、开闭(对扩展开放、对修改关闭)、里氏替换(子类型可替换基类型)、接口隔离(客户端不依赖不用的接口)、依赖倒置(依赖抽象而非具体)。各附正反例。

使用方式:评审查看是否存在不必要复杂度、投机功能、类的多职责、超过 500 行的 god class、依赖是否注入而非直接创建。可运行 wc -l <file> 检查行数,rg -c "class " <file>(或 grep -c "class " <file>)统计类数量。

原则冲突:小项目 KISS 优先,复杂度增长再引入 SOLID;抽象应有 2 个以上实现再加;可读性与 DRY 冲突时,宁可轻微重复也不要错误抽象。相关技能为 imbue:karpathy-principles,完整 gate-skill 图见 docs/quality-gates.md#skill-level-quality-gate-composition。

限制:未提供安装命令、许可证、价格或平台信息;示例仅为原则示意,不应直接照搬用于生产。