核心要点
命名表意：变量/函数名直接表达意图，避免缩写与误导。
小函数 + 单一职责：函数短、只做一件事，减少嵌套与副作用。
DRY 避免重复 + 显式错误处理：消除复制粘贴，错误不被吞掉。
清晰胜过聪明：保持一致风格，注释解释「为什么」而非「是什么」。
标准回答
整洁代码的目标
代码读的次数远多于写的次数，整洁代码追求让别人（和未来的自己）能快速读懂、安全修改。
核心原则
- 命名表意：用能表达意图的名字，避免
a、tmp、误导性命名。 - 小函数、单一职责：函数尽量短小、只做一件事，控制参数数量与嵌套层级。
- DRY：避免重复逻辑，把公共部分提炼复用，但避免过早抽象。
- 清晰胜过聪明：宁可朴素直白，也不用炫技式的晦涩写法。
- 显式错误处理：用异常或返回值明确处理错误，不静默吞掉。
- 一致风格：遵循团队规范，统一格式与命名约定。
- 注释讲「为什么」：好代码自解释，注释用于解释意图与权衡，而非复述代码。
常见误区
⚠️ 常见踩坑
过度注释（给一眼能懂的代码堆解释），以及过早抽象——为「将来可能用到」提前造通用框架，反而增加复杂度。
追问
追问 1：注释是越多越好吗？
不是。理想是代码自解释，靠命名和结构表达意图。注释应解释「为什么这样做」、记录权衡或坑点；复述代码的注释会随代码变更而过时、产生误导。
追问 2：DRY 是否应该无条件遵守？
不应。两段代码「现在长得像」未必出于同一原因，强行合并会造成错误耦合（AHA / WET 思想）。应在重复确实代表同一知识点、且稳定后再抽象。
延伸学习
与本题相关的知识库文章、术语、工具与行业资讯。