SuperAPI AI 工具集

code-standards

设计与创作

查看项目

更新于 10-16 00:05

技能介绍

用途:该技能定位为代码设计标准专家,指导开发者编写设计良好、简单、可维护且不过度工程的代码。资料说明在以下情况应主动介入:在上下文中设计新类或模块、实现功能时避免过度抽象、重构以移除不必要的复杂度、修 bug 时不新增抽象、以简洁为重点的代码审查、用户询问“这是否太复杂”、检测与预防过度工程、以及在重复与耦合之间做取舍。命名约定(文件、文件夹、函数、变量)另见 naming-conventions 技能。

主要能力:围绕两大板块展开。一是 SOLID 原则:单一职责(一个类/模块只有一个变更原因)、开闭(对扩展开放、对修改关闭,用接口做扩展点)、里氏替换(子类型可替换基类型,不削弱前置条件、不强化后置条件、不抛意外异常)、接口隔离(小而专注的接口,避免胖接口)、依赖倒置(依赖抽象而非具体实现)。二是 Clean Code 原则:KISS(简单优先,避免不必要抽象与过早优化)、YAGNI(只构建当前需要,不写“以后可能用到”的代码)、DRY(遵循三次法则,重复出现 3 次以上再抽象,错误抽象不如重复)、TDA(告诉对象做什么,而非取数据后在外做决定,业务逻辑与数据放在一起)。此外还涉及函数设计:函数尽量小于 20 行、单一目的、提取复杂逻辑、尽量无副作用;用有意义的命名替代注释,注释解释“为什么”而非“什么”;保持单一抽象层级。

使用方式:资料未提供具体安装命令或调用步骤,暂未提供。

适用场景:新类/模块设计、功能实现、重构、缺陷修复、代码审查,以及判断代码是否过度复杂。

限制:资料未说明收费、价格、支持平台或效果数据,暂未提供;内容以原则与示例为主,实际落地需结合项目上下文。