clean-code-javascript：94K Star 的 JavaScript 代码整洁指南

clean-code-javascript：94K Star 的 JavaScript 代码整洁指南

这个仓库在 GitHub 上拿了 94,456 Star。它只做一件事：告诉你 JavaScript 代码怎么写才算"干净"。

作者 Ryan McDermott 把 Robert C. Martin 的《Clean Code》里的原则搬到了 JavaScript 世界。这套指南收集的是多年实战中沉淀下来的编码经验。

1、它讲了什么

整个仓库按主题分成了 12 个章节：变量、函数、对象与数据结构、类、SOLID 原则、测试、并发、错误处理、格式、注释。每个章节里都是"坏写法 vs 好写法"的对比。

变量命名这块，它举了个例子：

// 坏 const yyyymmdstr = moment().format("YYYY/MM/DD"); // 好 const currentDate = moment().format("YYYY/MM/DD");

类似这样的对比贯穿全文。每条规则都有对应的代码示例，直接看代码就能理解为什么这样写更好。

2、为什么值得读

写代码的人迟早会碰到一个问题：代码能跑，但过三个月自己都看不懂。

这个仓库解决的就是这个问题。它不讲高深的架构理论，全是日常编码中能直接用的规则。比如函数只做一件事、参数不要超过两个、用默认参数代替短路运算、变量名要能搜索到。每条都是小事，但堆起来就是代码质量的分水岭。

它还有一整章专门讲注释。核心观点是：好代码自己会说话，注释是代码表达不清时的补救措施。如果一段代码需要注释才能让人看懂，那代码本身需要重写。

3、适合谁

• 写 JavaScript 或 TypeScript 的开发者，不管新手还是老手
• 团队里想统一代码风格、降低 review 成本的人
• 读过《Clean Code》想看看 JavaScript 版怎么落地的人

仓库是纯 Markdown，没有代码需要运行，打开浏览器直接读。建议通读一遍，然后在日常写代码时当速查手册用。遇到拿不准的写法，翻一章节对照一下，比从头到尾死记硬背管用。

写代码时当速查手册用。遇到拿不准的写法，翻一章节对照一下，比从头到尾死记硬背管用。