mcpField
C
clean-code

clean-code

github.com/pproenca开发220845 次安装11 周前更新
代码仓库

关于 clean-code

面向软件开发者的 Clean Code 实践指南，基于 Robert C. Martin 的著作并纳入现代修订，规则适用于多种编程语言。

主要功能

  1. 01涵盖 10 类代码实践
  2. 02按影响程度排列规则
  3. 03指导命名、函数与错误处理
  4. 04涉及对象、边界和系统设计
  5. 05包含单元测试与简单设计原则

适用场景

  1. 01编写或重构函数与类
  2. 02审查代码的可维护性
  3. 03改进单元测试
  4. 04封装第三方依赖

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/pproenca/dot-skills --skill clean-code

安装后在 Claude Code 中输入/clean-code确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

metadata.json
assets/templates/
_template.md
references/
_sections.md
bound-learning-tests.md
bound-wrap-third-party.md
class-cohesion.md
class-isolate-from-change.md
class-organize-for-change.md
class-separate-concerns.md
class-small.md
cmt-avoid-commented-out-code.md
cmt-avoid-redundant.md
cmt-explain-intent.md
cmt-express-in-code.md
cmt-warning-consequences.md
emerge-expressiveness.md
emerge-simple-design.md
err-avoid-null.md
err-define-by-caller-needs.md
err-provide-context.md
err-use-exceptions.md
err-write-try-catch-first.md
fmt-horizontal-alignment.md
fmt-indentation.md
fmt-team-rules.md
fmt-vertical-formatting.md
func-abstraction-level.md
func-command-query-separation.md
func-dry.md
func-minimize-arguments.md

详细介绍

Robert C. Martin（Uncle Bob）的 Clean Code 最佳实践

这是一份全面的软件工艺指南，基于 Robert C. Martin 的《Clean Code: A Handbook of Agile Software Craftsmanship》，并针对原书 2008 年的建议已不再适用之处进行了现代化修订。指南包含 10 个类别、48 条规则，并按影响优先级排序，帮助指导代码审查、重构决策和新开发。示例主要使用 Java，但原则与语言无关。

适用场景

在以下场景中参考这些指南：

  • 编写新的函数、类或模块
  • 为变量、函数、类或文件命名
  • 审查代码，查找可维护性问题
  • 重构现有代码以提升清晰度
  • 编写或改进单元测试
  • 封装第三方依赖

按优先级划分的规则类别

优先级类别影响前缀
1有意义的名称CRITICALname-
2函数CRITICALfunc-
3注释HIGHcmt-
4格式HIGHfmt-
5错误处理HIGHerr-
6对象和数据结构MEDIUM-HIGHobj-
7边界MEDIUM-HIGHbound-
8类和系统MEDIUM-HIGHclass-
9单元测试MEDIUMtest-
10涌现与简单设计MEDIUMemerge-

快速参考

1. 有意义的名称（CRITICAL）
2. 函数（CRITICAL）
3. 注释（HIGH）
4. 格式（HIGH）
5. 错误处理（HIGH）
6. 对象和数据结构（MEDIUM-HIGH）
7. 边界（MEDIUM-HIGH）
8. 类和系统（MEDIUM-HIGH）
9. 单元测试（MEDIUM）
10. 涌现与简单设计（MEDIUM）

如何使用

阅读各个参考文件，了解详细说明和代码示例：

参考文件

文件描述
references/_sections.md类别定义和排序
assets/templates/_template.md新规则模板
metadata.json版本和参考信息

评论

支持 Markdown