Nm Conserve Code Quality Principles

🦀 简洁代码之道:KISS、YAGNI与SOLID实战指南

提供KISS、YAGNI、SOLID等代码质量原则的指导,包含多语言实例,帮助识别过度工程并编写简洁可维护的代码。

收藏
4.9k
安装
991
版本
1.0.3
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

本 Skill 是一套代码质量原则的实践指南,涵盖三大核心准则:

  • KISS(保持简单):避免不必要的复杂度,优先选择显而易见的方案而非巧妙的技巧
  • YAGNI(你不会需要它):不实现当前不需要的功能,避免为假设的未来场景做过度设计
  • SOLID 五大原则:单一职责、开闭原则、里氏替换、接口隔离、依赖倒置

提供 Python、Rust、TypeScript 等语言的正反例对比,并包含代码审查检查清单(如行数统计、类数量检测等实用命令)。

显著优点

1. 实战导向:所有原则均配有可直接运行的代码示例,"Bad/Good" 对比清晰直观
2. 冲突解决指南:明确说明 KISS 与 SOLID、YAGNI 与 DIP 等原则冲突时的取舍策略

3. 可量化检查:提供 wc -lrg -c "class " 等命令行工具辅助审查

4. 场景化触发:精确限定适用场景(设计、重构、代码审查)与不适用场景(一次性脚本、性能关键代码)

潜在局限

1. 语言覆盖有限:示例以 Python/Rust/TypeScript 为主,Java/C++/Go 等工业语言示例缺失
2. 原则抽象度差异:SOLID 的 OCP/LSP 在动态语言中实践难度较高,示例未充分讨论

3. 团队协作依赖:原则本身是个人决策框架,缺乏团队级强制约束机制(需配合 linter/CI)

适合人群

  • 有一定经验、正在向高级工程师进阶的开发者
  • 参与代码审查的技术负责人
  • 遗留系统重构项目的技术决策者

常规风险

  • 教条化风险:新手可能过度追求 SOLID 而制造抽象层地狱,违背 KISS 本意
  • 场景误判:在数据科学脚本或算法竞赛代码中强行套用企业级架构原则
  • 版本漂移:Skill 版本 1.9.8 依赖 claude-night-market 生态,跨平台迁移时可能触发失效

Nm Conserve Code Quality Principles 内容

手动下载zip · 4.7 kB
skill-card.mdtext/markdown
请选择文件