⚡

清洁代码Skill clean-code

这个技能用于在软件开发过程中强制实施清洁代码原则，如SOLID、DRY、KISS和YAGNI，以提升代码质量、可读性和可维护性。通过自动检查、代码质量清单等方法，帮助开发者编写和修改代码时实现高效、简单且易于维护的代码结构。关键词：清洁代码、SOLID、DRY、KISS、代码质量、软件开发、编程原则、代码规范。

架构设计 0 次安装 0 次浏览 更新于 3/20/2026

name: clean-code description: 在实现期间强制实施 SOLID、DRY、KISS 原则。当编写或修改代码时自动激活。

清洁代码技能

目的

确保所有代码遵循清洁代码原则。

核心原则

SOLID

参考：principles/solid.md

DRY（不要重复自己）

参考：principles/dry.md

  • 提取公共逻辑到函数
  • 对魔法值使用常量
  • 创建共享实用工具

KISS（保持简单，愚蠢）

参考：principles/kiss.md

  • 偏爱可读性胜过聪明性
  • 一个函数只做一件事
  • 明显胜过隐含

YAGNI（你不会需要它）

参考：principles/yagni.md

  • 只实现现在需要的
  • 没有推测性的泛化
  • 需要时添加复杂性

代码质量清单

在提交前使用：checklists/pre-commit.md

命名

  • [ ] 变量描述内容
  • [ ] 函数描述动作
  • [ ] 类描述实体
  • [ ] 没有缩写（除了常见的）

函数

  • [ ] 单一职责
  • [ ] 首选少于 20 行
  • [ ] 少于 5 个参数
  • [ ] 尽可能无副作用

注释

  • [ ] 解释为什么，而不是什么
  • [ ] 代码变更时更新
  • [ ] 删除注释掉的代码

错误处理

  • [ ] 特定的错误类型
  • [ ] 有意义的消息
  • [ ] 适当的日志记录
  • [ ] 恢复或优雅失败

自动检查

实现时，验证：

npm run lint
npm run typecheck