SKILL

clean-code

务实的编码规范——简洁、直接、不过度设计、不写多余注释

机器翻译
查看英文原文

Pragmatic coding standards - concise, direct, no over-engineering, no unnecessary comments

适用对象:软件开发与测试。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。

查看英文原文

原文涵盖的主题

  • Clean Code - Pragmatic AI Coding Standards
  • Core Principles
  • Naming Rules
  • Function Rules
  • Code Structure
  • AI Coding Style
  • Anti-Patterns (DON'T)
  • 🔴 Before Editing ANY File (THINK FIRST!)

CRITICAL SKILL - Be concise, direct, and solution-focused. -- | Principle | Rule | |-----------|------| | SRP | Single Responsibility - each function/class does ONE thing | | DRY | Don't Repeat Yourself - extract duplicates, reuse | | KISS | Keep It Simple - simplest solution that works | | YAGNI | You Aren't Gonna Need It - don't build unused features | | Boy Scout | Leave code cleaner than you found it | -- | Element | Convention | |---------|------------| | Variables | Reveal intent: userCount not n | | Functions | Verb + noun: getUserById() not user() | | Booleans | Question form: isActive, hasPermission, canEdit | | Constants | SCREAMINGSNAKE: MAXRETRYCOUNT | Rule: If you need a comment to explain a name, rename it. -- | Rule | Description | |------|-------------| | Small | Max 20 lines, ideally 5-10 | | One Thing | Does one thing, does it well | | One Level | One level of abstraction per function | | Few Args | Max 3 arguments, prefer 0-2 | | No Side Effects | Don't mutate inputs unexpectedly | -- | Pattern | Apply | |---------|-------| | Guard Clauses | Early returns for edge cases | | Flat > Nested | Avoid deep nesting (max 2 levels) | | Composition | Small functions compos

这里只展示节选,请以完整原文和当前要求为准。

来源仓库
davila7/claude-code-templates
源文件
cli-tool/components/skills/development/clean-code/SKILL.md
固定版本
21be197f100a12b8d0dd9a211cc244c8179f84d3
阅读完整原作者说明 ↗

准备条件

  • 本条仅收录原作者的技能元数据;请阅读完整说明,确认依赖、许可与使用条件。

第一件可以尝试的小事

先阅读原作者说明,再决定是否在自己的 AI 工具中使用。

对应 AI 工具说明

作者有说明不等于本站实机验证。没有证据时,不自动标为兼容、安全或免费。

来源与内容状态

本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。

原作者:davila7/claude-code-templates · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-09T14:01:44.177Z。

分类由名称、说明与路径规则生成,分类不代表已核实适配。

许可与权利归属

MIT。第三方内容及版权归原作者,使用条件以原文为准。

许可原文 ↗

本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。

限制与注意事项

  • 元数据收录不代表本站已经安装、适配、实测或进行安全审查。