SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 05:06

技能介绍

用途:这是一份面向 .NET 开发者的整洁代码技能说明,用于在编写或评审代码时应用 DRY(不要重复自己)、KISS(保持简单)和 YAGNI(你不会需要它)三项原则,以保证代码的可维护性与简洁性。

主要能力: 一、DRY。要求每段知识在系统中只有单一、明确、权威的表示。资料给出多类反例与改法:重复的校验逻辑应抽取为 EmailValidator 等单一来源;散落的魔法数字与字符串应改为命名常量(如 OrderThresholds.FreeShippingMinimum、StandardDiscountRate);连接字符串等配置应集中到 DatabaseOptions 并经 IOptions 注入,而非在多个类里重复硬编码。同时提醒过度 DRY 有害,强行抽象会损害可读性,并给出“三次法则”:重复出现三次后再抽取。 二、KISS。最简方案通常最好。资料列举应避免的过度工程:简单场景套用接口、抽象基类与工厂;为单一实现提前建接口;嵌套难懂的 LINQ 应拆成可读步骤;布尔参数应改用命名参数或专用方法;深层继承应改为组合与接口。 三、YAGNI。只实现当前需要的东西。资料示例包括:不要为假设的未来需求给 CreateUser 加一堆可选参数;不要为只用 JSON 而实现 Xml、Yaml、Binary、MessagePack 等多种序列化器;不要保留没有第二实现的接口;不要在没有测量前就加内存与分布式多级缓存。并列出违反 YAGNI 的代价:开发时间、维护负担、复杂度、测试开销与技术债。

使用方式:资料未提供安装命令或具体调用步骤,仅说明该技能用于编写或评审 .NET 代码时参考,末尾附有整洁代码检查清单,涵盖命名、函数(建议小于 20 行、少参数、无副作用)、注释、格式、错误处理(用异常而非错误码、避免空 catch、快速失败),并提示参见 reference.md 获取更多示例。

适用场景:.NET 项目的代码编写、重构与代码评审,尤其针对重复逻辑、魔法值、过度抽象、过早优化等问题。

限制:内容为原则性指导与代码示例,非自动化工具;未说明支持的 .NET 版本、评分机制或强制执行方式;reference.md 的具体内容在给定资料中暂未提供。