技能 clean-code
🧹

clean-code

安全

将清洁代码原则应用于您的代码库

也可从以下获取: Benny9193,DoubleslashSE

编写既可运行又易于维护的代码。本技能应用Robert C. Martin的清洁代码原则,将混乱的代码转换为可读、可测试的专业软件,让其他开发者能够理解和修改。

支持: Claude Codex Code(CC)
🥉 74 青铜
1

下载技能 ZIP

2

在 Claude 中上传

前往 设置 → 功能 → 技能 → 上传技能

3

开启并开始使用

测试它

正在使用“clean-code”。 Review this function: def chk(u): if u.age>65 and u.tp=='h': return True

预期结果:

发现3个清洁代码违规:1) 函数名'chk'不揭示意图。建议:isEligibleForFullBenefits。2) 参数'u'不可搜索。建议:employee。3) 魔术比较'tp==h'使用了不清晰的缩写。提取到isHourly()方法或使用命名常量。提供了带解释的重构版本。

正在使用“clean-code”。 Apply Clean Code principles to this 50-line function that does validation, database save, sends email, and logs metrics

预期结果:

此函数违反了单一职责原则。拆分为4个函数:1) validateUserCredentials(),2) saveUserToDatabase(),3) sendWelcomeEmail(),4) logUserMetrics()。每个函数应该少于10行。主函数通过清晰的错误处理来协调这些步骤。

安全审计

安全
v2 • 2/25/2026

Static analysis detected 29 potential issues (external commands, network patterns, weak cryptography, system reconnaissance), but all are FALSE POSITIVES. The findings match Markdown code block delimiters (backticks), documentation examples, and reference URLs in educational content. The skill contains no executable code, performs no file operations, makes no network requests, and is purely documentation about software engineering principles. Safe to publish.

1
已扫描文件
95
分析行数
0
发现项
2
审计总数
未发现安全问题
审计者: claude 查看审计历史 →

质量评分

38
架构
100
可维护性
87
内容
43
社区
100
安全
100
规范符合性

你能构建什么

Pull Request代码审查

在PR审查期间应用清洁代码原则,在合并前就命名、函数大小和代码组织提供基于原则的建设性反馈。

遗留代码重构

通过识别代码异味、将大函数拆分为小函数以及改进命名约定,将难以维护的遗留代码转换为干净、可读的代码。

新功能开发

实现新功能时从一开始就编写干净的代码,确保函数小、命名有意义,并遵循行业最佳实践。

试试这些提示

审查此函数
根据清洁代码原则审查此函数。检查它是否做了一件事、是否有描述性名称、参数数量是否适当、是否足够小。建议改进:

[PASTE CODE]
重构此代码
应用清洁代码原则重构此代码。重点关注:有意义的名称、小函数、一层抽象、删除不良注释和适当的错误处理。解释每处更改:

[PASTE CODE]
识别代码异味
分析此代码库/文件中的代码异味,包括:僵化、脆弱、不可移动、粘性、不必要的复杂性和重复。列出具体问题和行号:

[PASTE CODE]
改进命名约定
审查此代码中的名称(变量、函数、类),检查是否具有揭示意图的清晰性、可读性和可搜索性。建议更好的名称并解释原因:

[PASTE CODE]

最佳实践

  • 在代码审查中使用该技能提供基于原则的客观反馈,而不是主观意见
  • 重构时增量应用清洁代码原则——不要试图一次性修复所有问题
  • 首先关注最有影响力的改进:函数大小、命名和消除代码重复
  • 在清洁代码原则与实际约束(如截止日期和团队背景)之间取得平衡

避免

  • 不要盲目应用所有原则而不考虑上下文——有时3个参数的函数是最清晰的解决方案
  • 避免为每一行代码添加注释——努力编写不需要解释的自文档化代码
  • 不要在没有测试的情况下重构——在做出结构更改之前确保有测试覆盖
  • 永远不要为了清洁而牺牲正确性——代码必须先能工作才能谈清洁

常见问题

我应该一直应用所有清洁代码原则吗?
不。清洁代码原则是指导方针,不是绝对规则。根据上下文、团队标准和项目限制务实地应用它们。关注最有影响力的改进:清晰的命名、小函数和单一职责。
此技能可以自动重构我的代码吗?
不。此技能提供基于清洁代码原则的分析、建议和重构示例。您必须审查建议并自己应用它们。始终测试重构后的代码以确保行为保持不变。
最重要的清洁代码原则是什么?
单一职责原则——函数和类应该做好一件事。这导致更小、更专注、可测试和可维护的代码。大多数其他清洁代码原则都源于这个核心思想。
此技能是否取代了代码审查的需要?
不。此技能通过提供基于原则的反馈来增强代码审查,但人类审查者带来AI无法完全复制的上下文、领域知识和团队特定考量。
遵循这些原则会使我的代码变慢吗?
通常不会。干净的代码往往更模块化和可测试,这可以使优化更容易。然而,微优化有时与清洁代码冲突。首先优先考虑清洁,只有在测量表明需要时才进行优化。
我可以将此技能与任何编程语言一起使用吗?
是的。清洁代码原则适用于所有编程语言。虽然技能中的具体示例可能使用某些语言,但底层概念——有意义的名称、小函数、清晰的抽象——在所有编程语言中都是通用的。

开发者详情

文件结构

📄 SKILL.md