|
|
@ -68,29 +68,29 @@ const cdr = 700; |
|
|
|
|
|
|
|
_Bad 👎🏻_ |
|
|
|
|
|
|
|
更多时候,评论应该包含一些“为什么”,而不是一些“是什么”。如果“什么”在代码中不清楚,那么代码可能太混乱了。 |
|
|
|
更多时候,注释应该包含一些“为什么”,而不是一些“是什么”。如果代码本身不能讲清楚“是什么”,那么这段代码可能太混乱了。 |
|
|
|
|
|
|
|
```javascript |
|
|
|
// 700ms的数量是根据UX A/B测试结果进行经验计算的。 |
|
|
|
// @查看: <详细解释700的一个链接> |
|
|
|
// The number of 700ms has been calculated empirically based on UX A/B test results. |
|
|
|
// @see: <详细解释700的一个链接> |
|
|
|
const callbackDebounceRate = 700; |
|
|
|
``` |
|
|
|
|
|
|
|
### 💩 使用母语写注释 |
|
|
|
|
|
|
|
如果您违反了“无注释”原则,那么至少尝试用一种不同于您用来编写代码的语言来编写注释。如果你的母语是英语,你可能会违反这个原则。 |
|
|
|
如果你违反了“无注释”原则,那么至少尝试用一种不同于你用来编写代码的语言来编写注释。如果你的母语是英语,你可以违反这个原则。 |
|
|
|
|
|
|
|
_Good 👍🏻_ |
|
|
|
|
|
|
|
```javascript |
|
|
|
// Закриваємо модальне віконечко при виникненні помилки. |
|
|
|
// 隐藏错误弹窗 |
|
|
|
toggleModal(false); |
|
|
|
``` |
|
|
|
|
|
|
|
_Bad 👎🏻_ |
|
|
|
|
|
|
|
```javascript |
|
|
|
// 隐藏错误弹窗 |
|
|
|
// Hide modal window on error. |
|
|
|
toggleModal(false); |
|
|
|
``` |
|
|
|
|
|
|
@ -137,7 +137,7 @@ document.location.search |
|
|
|
|
|
|
|
### 💩 不要处理错误 |
|
|
|
|
|
|
|
无论何时发现错误,都没有必要让任何人知道它。没有日志,没有错误弹框。 |
|
|
|
无论何时发现错误,都没有必要让任何人知道它。不要日志,不要错误弹框,问题不大。 |
|
|
|
|
|
|
|
_Good 👍🏻_ |
|
|
|
|
|
|
@ -161,7 +161,7 @@ try { |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
### 💩 广泛使用全局变量 |
|
|
|
### 💩 尽量使用全局变量 |
|
|
|
|
|
|
|
全球化的原则。 |
|
|
|
|
|
|
@ -271,7 +271,7 @@ function square(num) { |
|
|
|
|
|
|
|
### 💩 三角法则 |
|
|
|
|
|
|
|
就像鸟巢,鸟巢,鸟巢。 |
|
|
|
就像乌龟一样。缩进。缩进。缩进。 |
|
|
|
|
|
|
|
_Good 👍🏻_ |
|
|
|
|
|
|
@ -314,7 +314,7 @@ async function someFunction() { |
|
|
|
|
|
|
|
### 💩 混合缩进 |
|
|
|
|
|
|
|
避免缩进,因为它们会使复杂的代码在编辑器中占用更多的空间。如果你不喜欢回避他们,那就和他们捣乱。 |
|
|
|
避免缩进,它们会使复杂的代码在编辑器中占用更多的空间。如果你不喜欢回避缩进,那就胡乱缩进。 |
|
|
|
|
|
|
|
_Good 👍🏻_ |
|
|
|
|
|
|
@ -348,7 +348,7 @@ fruits.forEach(fruit => { |
|
|
|
|
|
|
|
### 💩 不要锁住你的依赖项 |
|
|
|
|
|
|
|
以非受控方式更新每个新安装的依赖项。为什么坚持使用过去的版本,让我们使用最先进的库版本。 |
|
|
|
以非受控方式更新每个新安装的依赖项。何必固步自封,让我们使用最先进的库版本。 |
|
|
|
|
|
|
|
_Good 👍🏻_ |
|
|
|
|
|
|
@ -369,7 +369,7 @@ package-lock.json |
|
|
|
|
|
|
|
### 💩 函数长的比短的好 |
|
|
|
|
|
|
|
不要把程序逻辑分成可读的部分。如果IDE的搜索停止,而您无法找到所需的文件或函数,该怎么办? |
|
|
|
不要把程序逻辑分成可读的部分。如果IDE的搜索停止,而你无法找到所需的文件或函数,该怎么办? |
|
|
|
|
|
|
|
- 一个文件中10000行代码是OK的。 |
|
|
|
- 一个函数体有1000行代码是OK的。 |
|
|
@ -377,11 +377,11 @@ package-lock.json |
|
|
|
|
|
|
|
### 💩 不要测试你的代码 |
|
|
|
|
|
|
|
这是重复且不需要的工作。 |
|
|
|
这是重复且非必要的工作。 |
|
|
|
|
|
|
|
### 💩 避免代码风格统一 |
|
|
|
|
|
|
|
编写您想要的代码,特别是在一个团队中有多个开发人员的情况下。这是“自由”原则。 |
|
|
|
想怎么写代码就怎么写代码,特别是在一个团队中有多个开发人员的情况下。这是“自由”原则。 |
|
|
|
|
|
|
|
### 💩 构建新项目不需要 README 文档 |
|
|
|
|
|
|
|