利用 AI 将‘能运行的代码’转化为‘洁净的代码’

解决代码维护痛点:通过将《Clean Code》的核心原则内化给 AI,让它不再仅仅关注功能的实现,而是将代码的“可读性”和“可维护性”作为首要目标,将凌乱的逻辑转化为专业级工程代码。

为什么需要这个技能

在快速迭代的开发过程中,很多代码处于“能跑就行”的状态。这种代码在短期内高效,但随着时间推移会积累大量的“技术债”:变量名含义模糊、函数体过长、逻辑耦合严重,导致后继开发者(或一个月后的你)难以理解和修改。

本技能将 Uncle Bob 的《Clean Code》哲学转化为 AI 的执行指令。它要求 AI 扮演一名资深架构师,不仅检查 Bug,更通过对命名、函数粒度、注释策略和错误处理的优化,将代码提升到工业级标准。

适用场景

  • 新功能开发:在初稿完成后,要求 AI 按照 Clean Code 原则进行一次全面润色。
  • 代码评审(PR Review):让 AI 基于具体原则(如 SRP 单一职责原则)提供可落地、有理论依据的修改建议。
  • 遗留代码重构:处理那些逻辑混乱、缺乏文档的旧代码,识别并消除“代码异味”(Code Smells)。
  • 统一团队标准:将一套标准的最佳实践应用于整个项目的代码生成过程中。

核心工作流

  1. 识别异味:AI 扫描代码,识别出如 genymdhms 这种不具描述性的命名,或超过 20 行的复杂函数。
  2. 应用原则重构
    • 命名优化:将 d 改为 elapsedTimeInDays,确保变量名揭示其意图。
    • 函数拆分:遵循“只做一件事”原则,将高层业务逻辑与底层细节(如正则处理)分离。
    • 消除冗余注释:通过重写代码逻辑使代码自解释,删除那些解释“怎么做”的废话注释。
  3. 验证与对齐:应用 TDD(测试驱动开发)的思想,确保重构后的代码在通过 F.I.R.S.T 原则验证的同时,逻辑与原版保持一致。
  4. 结构调整:按照“报纸隐喻”调整代码顺序,将高层抽象放在顶部,实现自顶向下的叙事感。

下载和安装

下载 clean-code 中文版 Skill ZIP

解压后将目录放入你的 AI 工具 skills 文件夹,重启工具后即可使用。具体路径参考内附的 USAGE.zh.md

你可能还需要

暂无推荐