Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kristy-hu authored Dec 14, 2024
1 parent 5bec5c7 commit 343052b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/i18n/zh-cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

将 Robert C. Martin 的 [*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) 的代码原则适配到 JavaScript 。本文不是一篇代码风格指南,而是一个用 JavaScript 生产 [可读,可复用,以及可重构的软件](https://www.notion.so/3rs-of-software-architecture.md) [(原文)](https://github.com/ryanmcdermott/3rs-of-software-architecture)的指南。

本文所涉及的原则没必要百分百遵守,人人都能适用的原则更是没几个。这些原则不过是框架,但却是 *Clean Code* 作者多年的经验之谈。
本文所涉及的原则不是人人适用,更没必要条条遵循。你可以把这些原则看作写代码时的指路牌,但它们是 *Clean Code* 作者多年的经验之谈。

我们软件行业只发展了短短 50 年,还有很多需要我们去学习。等到软件架构与建筑架构一样古老时,也许我们需要遵守更多硬性规则。而现在,让本文所涉及的这些原则成为你和你团队生产 JavaScript 代码的质量准则吧。
我们软件行业只发展了短短半个世纪,还有很多需要我们去学习。等软件架构和建筑架构一样古老时,也许我们会有更多硬性规则要遵守。但现在,让本文所涉及的这些原则成为你和你团队生产 JavaScript 代码的质量准则吧。

再提一句: 熟悉这些原则并不能立马让你成为一个更出色的软件开发,遵循这些原则多年也并不意味着你不再犯错。每一段代码都是从草稿开始,就像陶瓷最开始也是从粘土做起。当我们和同伴一起审代码、提高质量时,不要因为最初要改进的草稿代码而自责,要怪就怪这些代码!
再提一句: 熟悉这些原则并不能立马让你成为一个更出色的软件开发,遵循这些原则多年也不意味着你不再犯错。每一段代码最初都是草稿开始,就像陶瓷最开始也来自湿粘土。当我们和同伴一起审代码、提高质量时,不要因为最初要改的草稿代码而自责,要怪就怪这些代码!

## **变量**

Expand Down Expand Up @@ -52,7 +52,7 @@ getUser();

### 使用可搜索的名称

我们要读的代码比要写的多得多,所以我们写代码的可读性和可搜索性很重要。使用无意义的变量名会导致我们的程序难以理解,也会伤害我们的读者,所以尽量使用可搜索的变量名。类似
我们要读的代码比要写的多得多,所以我们代码的可读性和可搜索性很重要。使用无意义的变量名会让我们的程序难以理解,读者也读不懂,所以尽量使用可搜索的变量名。类似
[buddy.js](https://github.com/danielstjules/buddy.js)[ESLint](https://github.com/eslint/eslint/blob/660e0918933e6e7fede26bc675a0763a6b357c94/docs/rules/no-magic-numbers.md) 的工具可以帮助我们找到未命名的常量。

**不推荐:**
Expand Down Expand Up @@ -96,7 +96,7 @@ saveCityZipCode(city, zipCode);

```

### 避免让人臆测
### 避免让读者揣测

写清楚比藏着掖着好。

Expand Down Expand Up @@ -167,7 +167,7 @@ function paintCar(car) {

### 使用默认变量替代短路或条件语句

默认参数往往比短路写法更清晰。注意,如果你使用短路,你的函数只会给未定义表达式赋予默认值。其他“不正确”的值,如`''` 、`""``false``null``0``NaN`,均不会被替换为默认值。
默认参数往往比短路写法更清晰。注意,如果你使用短路,你的函数只会给未定义表达式赋予默认值。其他“不太正确”的值,如`''` 、`""``false``null``0``NaN`,均不会被替换为默认值。

**不推荐:**

Expand Down

0 comments on commit 343052b

Please sign in to comment.