写出一手烂代码的十九条准则

本文“实践”部分由作者编写，其余由Github网站的用户trekhleb编写。

原文地址：

https://github.com/trekhleb/state-of-heartshitcode/blob/master/README.zh-CN.md

这是一个你的项目应该遵循的垃圾代码书写准则的列表，把称为适当的垃圾代码。

实践：被别人夸”代码真的写的好漂亮“不能不说是一种荣誉。但是可能有人天生只会夸下面的代码：

01010101010101001010100101010010101010100101000010100010101011101010111
101010010101001010101111101010000001010

……

先不说这个。我们先来看一看什么叫做”烂代码“

获取徽章

如果你的仓库遵循垃圾代码书写准则，你应该用下面的"state-of-the-art shitcode" 徽章：

标记徽章的源代码:

[![State-of-the-art Shitcode](https://img.shields.io/static/v1?label=State-of-the-art&message=Shitcode&color=7B5804)](https://github.com/trekhleb/state-of-the-art-shitcode)

???? 以一种代码已经被混淆的方式命名变量

如果我们键入的东西越少，那么就有越多的时间去思考代码逻辑等问题。

Good ????????

let a = 42;

Bad ????????

let age = 42；

实践：作者对于此条准则有极大的认同。如果你是写十几行的短代码，那么你完全可以使用像a、d、w这样的变量或函数。但如果你是写几百行的长代码，如果你还用这样的名称，不但不好看，而且到后期你会完全不知道这是表达的什么意思。所以，与其用a、b、c不如用file_name、path、exception caught这样的名称。

???? 变量/函数混合命名风格

为不同庆祝一下。

Good ????????

let wWidth = 640;
let w_height = 480;

Bad ????????

let windowWidth = 640;
let windowHeight = 480;

实践：同上，这样的变量虽然自己能够略微看的懂，但是到后期别人开发的时候可能会给他们带来不便。

???? 不要写注释

反正没人会读你的代码。

Good ????????

const cdr = 700;

Bad ????????

更多时候，评论应该包含一些“为什么”，而不是一些“是什么”。如果“什么”在代码中不清楚，那么代码可能太混乱了。

// 700ms的数量是根据UX A/B测试结果进行经验计算的。
// @查看: <详细解释700的一个链接>
const callbackDebounceRate = 700;

实践：如果没有人会阅读你写的代码也无所谓。尽管可能过一段时间你也不知道它是干什么的了……

???? 使用母语写注释

如果您违反了“无注释”原则，那么至少尝试用一种不同于您用来编写代码的语言来编写注释。如果你的母语是英语，你可能会违反这个原则。

Good ????????

// Закриваємо модальне віконечко при виникненні помилки.
toggleModal(false);

Bad ????????

// 隐藏错误弹窗
toggleModal(false);

实践：同上。如果你在一个团队里，且他们也都遵循了这条守则，你们写的代码可能是这样的：

int Calculation(int num1,int num2){
  // حساب مجموع رقمين
  return num1+num2;
}
int multiplication(int num1,int num2){
  // 二つの数の積を計算します。
  return num1*num2;
}
int division(int num1,int num2){
  // 计算两个数商
  return num1/num2;
}
int main(){
  // กอง
  dicision(123,23);
}

所以，知道用英语写注释的重要性了吗

???? 尽可能混合不同的格式

为不同庆祝一下。

Good ????????

let i = ['tomato', 'onion', 'mushrooms'];
let d = [ "ketchup", "mayonnaise" ];

Bad ????????

let ingredients = ['tomato', 'onion', 'mushrooms'];
let dressings = ['ketchup', 'mayonnaise'];

实践：……

???? 尽可能把代码写成一行

Good ????????

document.location.search.replace(/(^\?)/,'').split('&').reduce(function(o,n){n=n.split('=');o[n[0]]=n[1];return o},{})

Bad ????????

document.location.search
  .replace(/(^\?)/, '')
  .split('&')
  .reduce((searchParams, keyValuePair) => {
    keyValuePair = keyValuePair.split('=');
    searchParams[keyValuePair[0]] = keyValuePair[1];
    return searchParams;
  },
  {}
)

实践：第一种堪比天书

???? 不要处理错误

无论何时发现错误，都没有必要让任何人知道它。没有日志，没有错误弹框。

Good ????????

try {
  // 意料之外的情况。
} catch (error) {
  // tss... ????
}

Bad ????????

try {
  // 意料之外的情况。
} catch (error) {
  setErrorMessage(error.message);
  // and/or
  logError(error);
}

???? 广泛使用全局变量

全球化的原则。

Good ????????

let x = 5;

function square() {
  x = x ** 2;
}

square(); // 现在x是25

Bad ????????

let x = 5;

function square(num) {
  return num ** 2;
}

x = square(x); // 现在x是25

???? 创建你不会使用的变量

以防万一。

Good ????????

function sum(a, b, c) {
  const timeout = 1300;
  const result = a + b;
  return a + b;
}

Bad ????????

function sum(a, b) {
  return a + b;
}

实践：如果你写的代码不需要太大的内存空间，你完全可以这么做。但是，如果你写的代码完全足够几个G的话……

MemoryError再这里等着你……

???? 如果语言允许，不要指定类型和/或不执行类型检查。

Good ????????

function sum(a, b) {
  return a + b;
}

// 在这里享受没有注释的快乐
const guessWhat = sum([], {}); // -> "[object Object]"
const guessWhatAgain = sum({}, []); // -> 0

Bad ????????

function sum(a: number, b: number): ?number {
  // 当我们在JS中不做置换和/或流类型检查时，覆盖这种情况。
  if (typeof a !== 'number' && typeof b !== 'number') {
    return undefined;
  }
  return a + b;
}

// 这个应该在转换/编译期间失败。
const guessWhat = sum([], {}); // -> undefined

???? 你应该有不能到达的代码

这是你的 "Plan B".

Good ????????

function square(num) {
  if (typeof num === 'undefined') {
    return undefined;
  }
  else {
    return num ** 2;
  }
  return null; // 这就是我的"Plan B".
}

Bad ????????

function square(num) {
  if (typeof num === 'undefined') {
    return undefined;
  }
  return num ** 2;
}

实践：同上

???? 三角法则

就像鸟巢，鸟巢，鸟巢。

Good ????????

function someFunction() {
  if (condition1) {
    if (condition2) {
      asyncFunction(params, (result) => {
        if (result) {
          for (;;) {
            if (condition3) {
            }
          }
        }
      })
    }
  }
}

Bad ????????

async function someFunction() {
  if (!condition1 || !condition2) {
    return;
  }
  
  const result = await asyncFunction(params);
  if (!result) {
    return;
  }
  
  for (;;) {
    if (condition3) {
    }
  }
}

实践：这样虽然看起来很好看，但是当解释器说你漏了一个大括号的话……

???? 混合缩进

避免缩进，因为它们会使复杂的代码在编辑器中占用更多的空间。如果你不喜欢回避他们，那就和他们捣乱。

Good ????????

const fruits = ['apple',
  'orange', 'grape', 'pineapple'];
  const toppings = ['syrup', 'cream',
                    'jam',
                    'chocolate'];
const desserts = [];
fruits.forEach(fruit => {
toppings.forEach(topping => {
    desserts.push([
fruit,topping]);
    });})

Bad ????????

const fruits = ['apple', 'orange', 'grape', 'pineapple'];
const toppings = ['syrup', 'cream', 'jam', 'chocolate'];
const desserts = [];

fruits.forEach(fruit => {
  toppings.forEach(topping => {
    desserts.push([fruit, topping]);
  });
})

实践：MemoryError等着你……

???? 不要锁住你的依赖项

以非受控方式更新每个新安装的依赖项。为什么坚持使用过去的版本，让我们使用最先进的库版本。

Good ????????

$ ls -la

package.json

Bad ????????

$ ls -la

package.json
package-lock.json

实践：很多第三方库的更新频率远远超出你的想象……

例如，Django的1.11版本和3.03版可以说是天翻地覆的变化。如果你愿意，你可以试试……

???? 函数长的比短的好

不要把程序逻辑分成可读的部分。如果IDE的搜索停止，而您无法找到所需的文件或函数，该怎么办?

• 一个文件中10000行代码是OK的。

• 一个函数体1000行代码是OK的。

• 处理许多服务(第三方和内部，也有一些工具、数据库手写ORM和jQuery滑块)在一个' service.js ' ?这是OK的。

实践：作者曾经有过网络爬虫的经历。爬下来的数据如果你存在一个文档里然后试图去读取它的时候大概是这样的：

Traceback(most recent call last):

    file G:/python_test/pachong.py,line 302 in <module>

    lines = file.readlines()

        ^

MemoryError

???? 不要测试你的代码

这是重复的并且不需要的工作。

实践：如果你不测试直接上阵的话……

Traceback(most recent call last):

    file G:/python_test/file.py,line 16 in <module>

    file G:/python_test/text.py,line 30in <module>

   fileC:/Users/Rain/AppData/Local/Programme/Python/Libs\BeautifalSoup3,line 6132 in <module>

    file G:/python_test/beautifalsoups.py,line 3 in <module>

from BeautifalSoup3 import bautifal_soup

                                       ^

ImportError:No such package 'bautifal_soup'

后来忙活了两天，才发现是拼写错了，少了个s

……………………………………………………………………

???? 避免代码风格统一

编写您想要的代码，特别是在一个团队中有多个开发人员的情况下。这是一个“自由”的原则。

???? 构建新项目不需要 README 文档

一开始我们就应该保持。

???? 保存不必要的代码

不要删除不用的代码，最多是注释掉。

实践：这些代码在执行是会很占内存。MemoryError又找到了一个好去处

知道如何写出烂代码了吗？再会。