clean-code
将整洁代码原则应用于 TypeScript
在没有明确指导的情况下编写可维护的 TypeScript 代码具有挑战性。此技能提供了 DRY、KISS 和 YAGNI 原则的实际示例,帮助您编写更整洁、更易读的代码,让您的团队能够理解。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "clean-code". Review this function for clean code principles: const calc = (a,b,f) => f ? a*b*0.1 : a*b
النتيجة المتوقعة:
- DRY:未检测到重复
- KISS:名称 'calc' 不清晰 - 应描述它计算什么
- 命名:参数 'f' 不具描述性 - 使用 'applyDiscount'
- 建议:重命名为 'CalculateTotal',使用 'applyDiscount' 参数
استخدام "clean-code". Help me apply clean code to this validation logic that repeats in multiple places
النتيجة المتوقعة:
- DRY:将验证提取到可重用函数中
- KISS:将复杂验证拆分为更小的专注检查
- YAGNI:仅添加当前需要的验证规则
- 命名:使用描述性名称,如 'isValidEmail' 而不是 'validate'
التدقيق الأمني
آمنAll 93 static findings are FALSE POSITIVES. This is a documentation-only skill containing educational content about clean code principles. The static analyzer detected patterns in TypeScript code examples within markdown documentation (template literals, fetch calls, constant declarations) and misinterpreted them as security issues. No executable code, network operations, file system access, or system commands exist in this skill. The content consists solely of educational code examples demonstrating software engineering best practices.
عوامل الخطر
⚙️ الأوامر الخارجية (58)
🌐 الوصول إلى الشبكة (10)
📁 الوصول إلى نظام الملفات (2)
درجة الجودة
ماذا يمكنك بناءه
学习整洁代码基础
通过实际示例理解 DRY、KISS 和 YAGNI 原则,以提高代码质量。
指导团队代码审查
在代码审查期间用作参考材料,向团队成员解释整洁代码原则。
建立编码标准
用于创建团队编码标准和最佳实践文档的参考。
جرّب هذه الموجهات
审查此 TypeScript 代码并识别 DRY 原则违规。建议重构以消除重复:[paste code]
此代码似乎过度设计了。应用 KISS 原则建议一个更简单的实现:[paste code]
分析此代码的 YAGNI 违规。识别当前不需要的功能或抽象:[paste code]
对此 TypeScript 代码执行完整的整洁代码审查,检查 DRY、KISS、YAGNI、命名约定和整洁代码检查清单。
أفضل الممارسات
- 为所有变量、方法和类使用具体、描述性的名称
- 保持方法小巧并专注于单一职责
- 在提取公共代码之前应用三次法则
تجنب
- 在至少有三个相似实现之前不要抽象代码
- 避免在未先测量性能的情况下进行过早优化
- 不要为没有未来计划的单一实现创建接口
الأسئلة المتكررة
此技能是否与 JavaScript 项目兼容?
此技能可以分析我的实际代码文件吗?
如何将其集成到我的开发工作流程中?
我的代码会被发送到外部服务吗?
如果我的团队使用不同的约定怎么办?
与自动化代码分析工具相比如何?
تفاصيل المطور
المؤلف
DoubleslashSEالترخيص
MIT
المستودع
https://github.com/DoubleslashSE/claude-workflows/tree/main/Plugins/dotnet-tdd/skills/clean-codeمرجع
main
بنية الملفات
📄 SKILL.md