SuperAPI AI 工具集

code-quality

编程与开发

查看项目

更新于 10-15 15:14

技能介绍

Code Quality 是一套系统化的代码质量改进技能,目标是通过代码评审、重构与调试三条主线,配合验证门机制,帮助开发者持续提升代码质量。其资料以模块选择表组织:用户根据当前需求选择对应模块与参考文档,例如接收反馈、请求评审、完成前验证、降低复杂度、函数式模式、发现代码坏味道、测试策略、调查缺陷、追溯根因、添加验证、验证修复等。

核心原则方面,技能要求始终遵循 YAGNI、KISS、DRY;保持诚实、直接、切中要点、简洁;技术正确优先于社交舒适;实现前先验证,假设前先提问,断言前先有证据。

代码评审分为两条路径。接收反馈遵循“阅读—理解—验证—评估—回应—实现”的模式,规则包括:禁止表演式认同(如“你说得对!”“好观点!”),禁止未经验证就实现;应复述需求、提出问题、用推理进行反驳;并在实现建议前用 grep 检查使用情况以执行 YAGNI 检查。反馈来源区分人类伙伴与外部评审者,前者在理解后实现,后者需先做技术验证再实现。请求评审的时机为:重大功能完成后、合并前、复杂修复后。流程为:获取 SHA(BASE_SHA=$(git rev-parse HEAD~1)、HEAD_SHA=$(git rev-parse HEAD)),通过 Agent 工具派发评审者(deep-reviewer)或运行 /code-review,并传递 WHAT、PLAN、SHA、DESCRIPTION 信息;关键问题立即修复,重要问题在继续前修复,次要问题记录在案。

验证门要求:只有在本会话中运行了能证明结果的命令并读取其输出后,才能声称得到某结果;没有该证据的断言只是猜测。验证门流程为:识别—运行—读取—验证—再声称。

重构部分强调心态:不遗余力地简化,虔诚地保留行为,度量一切;每次重构都应小步安全、立即测试、可度量地更好。协议包括:评估(基线度量、识别坏味道、债务分类)、安全网(验证测试覆盖、添加特征化测试)、红绿重构(写失败测试、最小通过、改进设计)、模式应用(SOLID、设计模式、函数式转换)、验证(度量改进、验证行为保留)。代码坏味道分五类:膨胀者(长方法、大类、长参数列表)、面向对象滥用者(switch 语句、临时字段)、变化阻止者(发散式变化、霰弹式修改)、冗余物(重复代码、死代码、懒惰类)、耦合者(依恋情结、不当亲密)。快速模式包括面向对象的提取方法、内联、以查询替换临时变量、卫语句,以及函数式的 Map/Filter/Reduce、纯函数、组合、不可变性。

调试部分的核心原则是:没有根因调查就不修复;随机修复浪费时间并制造新 bug。四项技术为:系统化调试(阶段一:根因调查;阶段二:模式分析;阶段三:假设检验;阶段四:实现)、根因追溯(沿调用栈反向追踪原始触发点)、纵深防御(在入口、业务逻辑、环境、调试每一层都做验证)、验证(运行命令、读取输出、再声称结果)。快速索引为:遇到 bug 查 systematic-debugging.md(阶段一至四);错误深埋栈中查 root-cause-tracing.md;找到根因查 defense-in-depth.md;准备声称成功查 verification.md。

危险信号包括:想着“先快速修复,以后再调查”“先改改 X 看看”“大概是 X,我来修一下”“现在应该能用了”“似乎修好了”时就应停止。

参考文档涵盖:评审类(code-review-reception.md、requesting-code-review.md、verification-before-completion.md)、重构类(oop-refactoring-catalog.md、functional-refactoring-patterns.md、code-smells-reference.md、testing-strategies.md)、调试类(systematic-debugging.md、root-cause-tracing.md、defense-in-depth.md、verification.md)。总体底线:评审以技术严谨取代社交表演;重构件小、安全、有测试、可度量;调试根因优先、一次修好;始终证据先于断言——先验证、先质疑,再实现;先有证据,再下结论。资料未提供该技能的安装命令、收费模式、支持平台或具体效果数据。