编写既可运行又易于维护的代码。本技能应用Robert C. Martin的清洁代码原则,将混乱的代码转换为可读、可测试的专业软件,让其他开发者能够理解和修改。
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“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行。主函数通过清晰的错误处理来协调这些步骤。
安全审计
安全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.
质量评分
你能构建什么
Pull Request代码审查
在PR审查期间应用清洁代码原则,在合并前就命名、函数大小和代码组织提供基于原则的建设性反馈。
遗留代码重构
通过识别代码异味、将大函数拆分为小函数以及改进命名约定,将难以维护的遗留代码转换为干净、可读的代码。
新功能开发
实现新功能时从一开始就编写干净的代码,确保函数小、命名有意义,并遵循行业最佳实践。
试试这些提示
根据清洁代码原则审查此函数。检查它是否做了一件事、是否有描述性名称、参数数量是否适当、是否足够小。建议改进: [PASTE CODE]
应用清洁代码原则重构此代码。重点关注:有意义的名称、小函数、一层抽象、删除不良注释和适当的错误处理。解释每处更改: [PASTE CODE]
分析此代码库/文件中的代码异味,包括:僵化、脆弱、不可移动、粘性、不必要的复杂性和重复。列出具体问题和行号: [PASTE CODE]
审查此代码中的名称(变量、函数、类),检查是否具有揭示意图的清晰性、可读性和可搜索性。建议更好的名称并解释原因: [PASTE CODE]
最佳实践
- 在代码审查中使用该技能提供基于原则的客观反馈,而不是主观意见
- 重构时增量应用清洁代码原则——不要试图一次性修复所有问题
- 首先关注最有影响力的改进:函数大小、命名和消除代码重复
- 在清洁代码原则与实际约束(如截止日期和团队背景)之间取得平衡
避免
- 不要盲目应用所有原则而不考虑上下文——有时3个参数的函数是最清晰的解决方案
- 避免为每一行代码添加注释——努力编写不需要解释的自文档化代码
- 不要在没有测试的情况下重构——在做出结构更改之前确保有测试覆盖
- 永远不要为了清洁而牺牲正确性——代码必须先能工作才能谈清洁