SuperAPI AI 工具集

refactoring-decisions

编程与开发

查看项目

更新于 10-16 07:29

技能介绍

用途

该技能用于在重构代码或收到重构请求时,提供一个 6 道关卡的决策框架,帮助判断重构是否合适以及何时停止。

主要能力

  • 提供 6 道关卡,逐项检查重构的前提条件。
  • 明确重构的定义:仅指保持行为不变的代码修改;若行为发生变化,则不属于重构。
  • 在任一关卡不通过时,给出应停止并采取的替代方案。
  • 要求代理在重构前明确检查全部 6 道关卡并说明每项结果,即使用户已看到较早关卡失败,也需呈现完整情况。
  • 要求一次只进行一项重构,并在每次之间提交。
  • 要求使用小的、保持行为的步骤,每一步都应独立安全。

6 道关卡

  1. 这真的是重构吗?重构 = 仅保持行为的修改。若在修复缺陷、添加功能或处理新需求,则不是重构,应如实说明。若不通过:停止,讨论需要什么系统变更,不要将功能工作伪装成重构。
  2. 示例是否契合计划的重构?若改进匹配“几乎全部”情况但产生例外,不要强行抽象。三行相似代码优于带例外的过早抽象。若不通过:调查其他代码异味,或等待使模式更清晰的新需求。
  3. 是否已有其他重构在进行?绝不同时进行两项重构。创建方法并移除变量是两项重构。应完整完成一项——保存、测试、提交——再开始下一项。若通过:先完成当前重构,提交后再开始此项。
  4. 这段代码是否经常变动?目标应是既复杂又频繁变动的代码。改进从不变化的代码没有收益。检查 git 历史——若文件数月未被触及,跳过。警惕一厢情愿:因看不到改进方式而说服自己代码不会变化。若不通过:寻找更易变动的代码进行重构,或完全暂停重构。
  5. 是否有测试?没有测试就无法保证行为不变。若在不知情的情况下改变行为,就不是重构,而是在引入缺陷。若不通过:先写测试。测试有助于了解代码,一旦存在测试,就可以安全重构。
  6. 是否发现意外复杂度?若在重构中途发现不理解的内容,停止。若一直使用小步骤,目前所做的整理可安全保留或容易回退。若通过:暂停,待了解更多后再继续。Martin Fowler:重构是“一系列小的保持行为的变换”——每一步都应独立安全。

使用方式

在重构前,明确检查全部 6 道关卡并说明每项结果。若任一关卡不通过,说明是哪一项(或哪几项)以及应改做什么。一次只做一项重构,每次之间提交。使用小的、保持行为的步骤,每一步都应独立安全。

适用场景

适用于重构代码或收到重构请求时,用于判断重构是否合适以及何时停止。

限制

资料未提供关于收费、价格、平台、效果或具体使用步骤的更多信息。