整洁代码原则

版本: 1.0 | 更新: 2026-02-04

让代码如优美的散文，读之令人愉悦

概述

做了什么

提供一套整洁代码的核心原则和评判标准，帮助你写出可读、可维护、令人愉悦的代码。

为什么需要

• •糟糕的代码会拖慢开发速度，最终可能毁掉一个产品甚至一家公司
• •读代码的时间远超写代码的时间（比例超过 10:1）
• •代码会随时间腐坏，必须持续保持整洁

什么时候必须用

• •编写任何代码时
• •代码评审时
• •重构遗留代码时
• •培训新人时

何时使用此 Skill

核心理念

为什么代码永远重要

"代码确然是我们最终用来表达需求的那种语言。我们永远无法抛弃必要的精确性——所以代码永存。"

有人幻想代码会消失，需求可以直接生成程序。这永远不会发生。即便是 AI 时代，代码依然是精确表达需求的唯一方式。

糟糕代码的代价

勒布朗法则：稍后等于永不（Later equals never）

整洁代码的价值

"花时间保持代码整洁不但有关效率，还有关生存。"

大师们对整洁代码的定义

Bjarne Stroustrup（C++ 之父）

"我喜欢优雅和高效的代码。代码逻辑应当直截了当，叫缺陷难以隐藏；尽量减少依赖关系，使之便于维护；依据某种分层战略完善错误处理代码；性能调至最优，省得引诱别人做没规矩的优化，搞出一堆混乱来。整洁的代码只做好一件事。"

关键词：优雅、高效、直截了当、只做一件事

Grady Booch（UML 创始人之一）

"整洁的代码简单直接。整洁的代码如同优美的散文。整洁的代码从不隐藏设计者的意图，充满了干净利落的抽象和直截了当的控制语句。"

关键词：简单直接、如散文般可读、意图清晰

"老大" Dave Thomas（Eclipse 教父）

"整洁的代码应可由作者之外的开发者阅读和增补。它应当有单元测试和验收测试。它使用有意义的命名。它只提供一种而非多种做一件事的途径。它只有尽量少的依赖关系，而且要明确地定义和提供清晰、尽量少的 API。"

关键词：可读可增补、有测试、有意义的命名、尽量少

Michael Feathers（《修改代码的艺术》作者）

"整洁的代码总是看起来像是某位特别在意它的人写的。几乎没有改进的余地。代码作者什么都想到了，如果你企图改进它，总会回到原点，赞叹某人留给你的代码——全心投入的某人留下的代码。"

关键词：在意（Care）

Ron Jeffries（极限编程创始人之一）

简单代码，依其重要顺序：

1. •能通过所有测试
2. •没有重复代码
3. •体现系统中的全部设计理念
4. •包括尽量少的实体

关键词：无重复、有表达力、小规模抽象

Ward Cunningham（Wiki 发明者）

"如果每个例程都让你感到深合己意，那就是整洁代码。如果代码让编程语言看起来像是专为解决那个问题而存在，就可以称之为漂亮的代码。"

关键词：深合己意、语言为问题而生

整洁代码核心特征

一句话总结

【强制】整洁代码规则

为什么要写整洁代码

读代码 vs 写代码

"读与写花费时间的比例超过 10:1。写新代码时，我们一直在读旧代码。"

结论：要想写得快，先让代码易读。

破窗效应

"窗户破损了的建筑让人觉得似乎无人照管。于是别人也再不关心。他们放任窗户继续破损。最终自己也参加破坏活动。一扇破损的窗户开辟了大厦走向倾颓的道路。"

结论：糟糕的代码会引诱更多糟糕的代码。

态度问题

"程序员遵从不了解混乱风险的经理的意愿，也是不专业的做法。"

结论：

• •保持代码整洁是程序员的专业责任
• •不能把代码糟糕归咎于进度压力
• •制造混乱无助于赶上期限，只会拖慢速度

童子军军规

让营地比你来时更干净

应用到编程：

让代码比你签出时更干净

【推荐】每次提交的小改进

代码感（Code-Sense）

什么是代码感

"写整洁代码，需要遵循大量的小技巧，贯彻刻苦习得的'整洁感'。这种'代码感'就是关键所在。"

有无代码感的区别

如何培养代码感

1. •多读好代码：阅读优秀开源项目
2. •多写代码：练习，练习，再练习
3. •多重构：把自己的烂代码改好
4. •多评审：参与团队代码评审
5. •多思考：每写一行代码都问"这是最好的表达方式吗？"

反例：糟糕代码的特征

【强制】禁止的代码特征

反例代码

// ❌ 反例 - 糟糕的代码
public void doStuff(int d) {
    for (int i = 0; i < d; i++) {
        // 处理
        if (flag) {
            if (x > 0) {
                if (y > 0) {
                    // 做一些事
                    calc();
                    // 做另一些事
                    save();
                    // 做更多事
                    notify();
                }
            }
        }
    }
}

// ✅ 正例 - 整洁的代码
public void processOrders(int orderCount) {
    for (int i = 0; i < orderCount; i++) {
        processOrder(i);
    }
}

private void processOrder(int orderIndex) {
    if (!isOrderValid(orderIndex)) {
        return;
    }
    
    calculateOrderTotal(orderIndex);
    saveOrder(orderIndex);
    notifyCustomer(orderIndex);
}

整洁代码 Checklist

编写代码时自查

代码评审时检查

记忆锚点

终极问题

"你还得练，孩子，还得练！"

读书不能让你成为艺术家，只能告诉你工具和技巧。要写出整洁代码，唯有：

练习，练习，再练习！

禁则速查表

参考资料