GitHub这份垃圾代码书写准则，火了-白红宇

GitHub这份垃圾代码书写准则，火了

阅读量：2044 次

发布时间：2019-04-28

本文共 4630 字，大约阅读时间需要 15 分钟。

关注+星标公众号，不错过精彩内容

编排 | strongerHuang

微信公众号 | 嵌入式专栏

在 GitHub 上有一个新项目，它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。

为了保持与原 GitHub 项目一致的风格，下文没有进行转换。读者们可以以相反的角度来理解所有观点，这样就能完美避免写出垃圾代码。

当然，以下十九条垃圾代码书写准则并没有面面俱到，如果读者们发现有一些难以忍受的烂代码习惯，也可以留言发表你的看法。

这是一个你的项目应该遵循的垃圾代码书写准则的列表：

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

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

Good ????????

let a = 42;

Bad ????????

let age = 42;

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

为不同庆祝一下。

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);

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

为不同庆祝一下。

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;}

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

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]);   });})