概述

目的与范围

本文档概述了 clean-code-javascript 存储库，该存储库基于 Robert C. Martin 的著作“Clean Code”提供了编写干净、可维护的 JavaScript 代码的全面指南。与传统的软件系统不同，此存储库充当参考指南，概述了特别适用于 JavaScript 开发的软件工程原则和最佳实践。

有关特定干净代码原则的详细信息，请参阅以下章节：变量、函数、对象和数据结构、类、 SOLID 原则、测试、并发、错误处理和格式和注释。

来源： README.md18-44

什么是干净代码？

干净代码是可读、可维护和可重构的代码。该存储库通过以下特征定义了干净代码：

可读：代码清楚地传达其意图
可重用：代码可以在不同上下文中重用
可重构：可以在不破坏功能的情况下更改代码

该存储库承认这些原则是指导方针而非严格规则，并且干净代码是主观的，并且随着软件工程领域的成熟而不断发展。

来源： README.md20-44

仓库组织结构

clean-code-javascript 存储库分为几个主要部分，每个部分都侧重于干净 JavaScript 编写的一个特定方面。每个部分都提供解释、要避免的不良示例以及要遵循的良好示例。

图：存储库内容结构

来源： README.md3-16

关键原则概述

该存储库涵盖了几项编写干净 JavaScript 的基础原则，总结如下：

章节	核心原则	对代码质量的影响
变量	有意义的名称、可搜索的术语、解释性的变量	提高可读性和可维护性
函数	单一职责、少量参数、纯函数	降低复杂性并提高可测试性
对象和数据结构	封装、getter/setter、私有成员	更好的数据保护和接口设计
类	ES6 类语法、组合优于继承	更易于维护的对象层次结构
SOLID	面向对象编程的五个设计原则	更灵活、更易于维护的架构
测试	每个测试单一概念、充分的覆盖率	确保代码按预期工作
并发	Promises、async/await 优于回调	更干净的异步代码
错误处理	正确处理错误和拒绝的 Promises	更健壮的应用程序
格式化	一致的命名约定、代码组织	提高可读性
注释	最小化，专注于业务逻辑的复杂性	优先考虑自文档化代码