垃圾代码书写准则

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

Read this in other languages:
English,
한국어

获取徽章

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

标记徽章的源代码:

  • 01
[![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 👍🏻

javascript
  • 01
let a = 42;

Bad 👎🏻

javascript
  • 01
let age = 42;

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

为不同庆祝一下。

Good 👍🏻

javascript
  • 01
  • 02
let wWidth = 640; let w_height = 480;

Bad 👎🏻

javascript
  • 01
  • 02
let windowWidth = 640; let windowHeight = 480;

💩 不要写注释

反正没人会读你的代码。

Good 👍🏻

javascript
  • 01
const cdr = 700;

Bad 👎🏻

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

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

💩 使用母语写注释

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

Good 👍🏻

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

Bad 👎🏻

javascript
  • 01
  • 02
// 隐藏错误弹窗 toggleModal(false);

💩 尽可能混合不同的格式

为不同庆祝一下。

Good 👍🏻

javascript
  • 01
  • 02
let i = ['tomato', 'onion', 'mushrooms']; let d = [ "ketchup", "mayonnaise" ];

Bad 👎🏻

javascript
  • 01
  • 02
let ingredients = ['tomato', 'onion', 'mushrooms']; let dressings = ['ketchup', 'mayonnaise'];

💩 尽可能把代码写成一行

Good 👍🏻

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

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
  • 10
document.location.search .replace(/(^\?)/, '') .split('&') .reduce((searchParams, keyValuePair) => { keyValuePair = keyValuePair.split('='); searchParams[keyValuePair[0]] = keyValuePair[1]; return searchParams; }, {} )

💩 不要处理错误

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

Good 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
try { // 意料之外的情况。 } catch (error) { // tss... 🤫 }

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
try { // 意料之外的情况。 } catch (error) { setErrorMessage(error.message); // and/or logError(error); }

💩 广泛使用全局变量

全球化的原则。

Good 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
let x = 5; function square() { x = x ** 2; } square(); // 现在x是25

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
let x = 5; function square(num) { return num ** 2; } x = square(x); // 现在x是25

💩 创建你不会使用的变量

以防万一。

Good 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
function sum(a, b, c) { const timeout = 1300; const result = a + b; return a + b; }

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
function sum(a, b) { return a + b; }

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

Good 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
function sum(a, b) { return a + b; } // 在这里享受没有注释的快乐 const guessWhat = sum([], {}); // -> "[object Object]" const guessWhatAgain = sum({}, []); // -> 0

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
  • 10
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 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
function square(num) { if (typeof num === 'undefined') { return undefined; } else { return num ** 2; } return null; // 这就是我的"Plan B". }

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
function square(num) { if (typeof num === 'undefined') { return undefined; } return num ** 2; }

💩 三角法则

就像鸟巢,鸟巢,鸟巢。

Good 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
  • 10
  • 11
  • 12
  • 13
  • 14
function someFunction() { if (condition1) { if (condition2) { asyncFunction(params, (result) => { if (result) { for (;;) { if (condition3) { } } } }) } } }

Bad 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
async function someFunction() { if (!condition1 || !condition2) { return; } const result = await asyncFunction(params); if (!result) { return; } for (;;) { if (condition3) { } } }

💩 混合缩进

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

Good 👍🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
  • 10
  • 11
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 👎🏻

javascript
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
const fruits = ['apple', 'orange', 'grape', 'pineapple']; const toppings = ['syrup', 'cream', 'jam', 'chocolate']; const desserts = []; fruits.forEach(fruit => { toppings.forEach(topping => { desserts.push([fruit, topping]); }); })

💩 不要锁住你的依赖项

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

Good 👍🏻

  • 01
  • 02
  • 03
$ ls -la package.json

Bad 👎🏻

  • 01
  • 02
  • 03
  • 04
$ ls -la package.json package-lock.json

💩 函数长的比短的好

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

  • 一个文件中10000行代码是OK的。
  • 一个函数体有1000行代码是OK的。
  • 在一个' service.js ' 中处理许多服务(第三方库和内部库、一些工具、手写的数据库ORM和jQuery滑块)? 这是OK的。

💩 不要测试你的代码

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

💩 避免代码风格统一

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

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

一开始我们就应该保持。

💩 保存不必要的代码

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