用途:这是一份面向 C#/.NET 的整洁代码实践清单,改编自 Robert C. Martin 的原则,适合在代码评审(code review)和重构时逐项对照检查。
主要能力(按主题组织): 命名:使用有意义、可发音的名称,避免匈牙利命名法,优先使用领域命名(如 Factory、Repository),去除冗余前缀。 变量:用提前返回(guard clause)替代深层嵌套,避免魔法字符串(用常量或 enum),使用默认参数,避免不必要的上下文。 函数:单一职责、避免副作用(优先纯函数)、避免否定式条件、避免用布尔标志参数区分职责、参数控制在 2 个以内(超出时用配置对象)、封装条件判断、删除死代码。 SOLID:单一职责(SRP)、开闭(OCP,用接口扩展而非修改分支)、里氏替换(LSP)、接口隔离(ISP)、依赖倒置(DIP,依赖抽象)。其中把构造函数依赖数量当作 SRP 指示信号:1-5 个正常,6-8 个需要复查拆分机会,9 个及以上视为需要重构;并提出抽取服务、Facade、领域事件、Mediator 等重构策略。 错误处理:不要写 throw ex(会丢失堆栈),使用 throw 或包装内层异常;不要静默吞掉异常;用多个 catch 块而非在 catch 内做类型判断。 注释:避免 region 与位置标记、不要保留被注释掉的代码(交给版本控制)、只在解释业务逻辑“为什么”时写注释。
使用方式:作为评审与重构的检查清单逐项核对。文中附带代码示例对比正误写法,但未给出安装命令或工具链配置。
适用场景:C#/.NET 项目的代码评审、重构与团队编码规范梳理。
限制:资料未提供具体工具、自动检查集成、收费或价格信息;依赖数量阈值仅为经验性指引。