SuperAPI AI 工具集

principle-minimize-reader-load

编程与开发

查看项目

更新于 10-16 07:07

技能介绍

用途

该技能适用于审查或塑造难以追踪的代码。它把“可维护性”定义为读者理解代码所需付出的工作,并给出两个可操作的衡量轴:

  • 追踪层数:问题与答案之间有多少间接层。
  • 需记住的状态:读者必须在脑中保留多少隐藏或可变上下文。

主要能力

  • 识别并折叠成本高于收益的层:只有一个调用者的包装、没有第二实现的适配器、从未需要的推测性间接层,将其内联。
  • 要求相邻层改变抽象:重复相同方法与参数的层只增加读者负担而不带来压缩,应折叠透传层。
  • 要求接口压缩:宽泛接口若隐藏的复杂度很少,会迫使读者同时学习表面与实现;优先选择隐藏有意义决策的边界。
  • 缩小状态作用域:倾向纯函数(返回而非修改)、局部变量而非字段、字段而非模块状态、模块状态而非全局;派生而非同步。
  • 在边界处命名不变量,而非在每个消费者处重复,使读者只需学习一次。
  • 在添加层或状态前,先问:这是否在其他地方至少等量降低了读者负担?

使用方式

该技能以原则形式提供,用于代码审查或代码塑造过程中的判断依据。具体触发条件为“审查或塑造难以追踪的代码”。资料未提供安装命令、代码示例或集成方式。

适用场景

  • 代码审查中判断某层间接或某状态是否值得保留。
  • 重构时决定是否内联单调用者包装、无第二实现的适配器或推测性间接层。
  • 设计接口边界时评估其是否隐藏了有意义的决策。
  • 管理状态作用域时选择纯函数、局部变量、字段、模块状态或全局。

限制

资料未提供该技能的具体实现、依赖、平台支持、收费方式或使用步骤。其检验标准为:新读者能否在30秒内回答“X从哪来”和“什么能改变X”;若不能,则削减层数或状态。