SuperAPI AI 工具集

code-quality

测试与质量

查看项目

更新于 10-15 20:05

技能介绍

用途:这是一份与框架无关的通用代码质量检查清单,用于代码审查、审计或实现阶段,作为评判代码质量的标准参考。

主要能力:围绕四条核心原则展开。DRY(避免重复):同一模式出现 3 次及以上时提取为可复用单元(函数、模块、类型),常量、类型、schema 保持单一事实来源,共享逻辑放入专用模块;但仅 2 处相似代码不必提取,等到第 3 次再动手。KISS(保持简单):采用能工作的最简方案,不炫技,若初级开发者 30 秒内看不懂就应简化,优先直白代码而非优雅抽象。YAGNI(不做多余功能):不提前构建尚未需要的功能,不为“以防万一”增加可配置性,不为一次性操作写辅助函数。SRP(单一职责):每个函数只做一件事,每个类或模块只负责一个领域,若描述其职责需要用到“和”字就应拆分。

其他内容:减少代码量但保持逻辑不变,包括彻底删除死代码(不留注释掉的代码和 _unused 变量)、用提前返回替代嵌套 if/else、合并相关变量、内联琐碎的一行逻辑。可复用性检查清单要求同时满足 3 次以上出现、契约一致、抽象稳定、可独立测试四项条件才提取,否则保持内联。反模式对照表列出常见错误做法与正确做法,例如不要为一行代码建辅助函数、不要为硬编码值加配置项、不要为两个对象建工厂、不要提前增加“灵活性”。

使用方式:在审查或实现代码时加载本参考,并逐条自问:是否存在应提取的重复逻辑、能否在不损失功能的前提下更简单、是否有“以防万一”而构建的内容、每个函数或组件是否只做一件事、是否有应删除的死代码。

适用场景与限制:适用于任意语言与框架的代码审查和实现。资料未提供具体安装命令、平台支持、收费方式或效果数据。