专栏首页编程学习基地你见过最烂的代码长什么样子?

你见过最烂的代码长什么样子?

有几个回答,我觉的挺有意思,也分享出来给大家。

知乎用户@请叫我大叔可好,在给小姐姐修电脑时候,发现了路由器里的秘密。

很多人问,修好电脑之后的故事,没写出来。

知乎用户@jack60506 ,入职第二天就离职了,因为看到下面的代码。

还有,判断奇偶数的代码,有网友是这样写的,我看完直呼行家。

鲁迅说:

好代码的样子千篇一律,它们是遵循代码规范的工业级产品。

坏代码的样子各不相同,体现了程序员个性鲜明的编码癖好。

有些人表示不服,要给坏代码正名,他们强调:坏代码,也该有属于自己的编码规范!

这不,还真编写起了规范,并且在 github 上开源出来了,项目地址:https://github.com/trekhleb/state-of-the-art-shitcode

这个项目的作者,以 JavaScript 为例,整理了如下代码规范,可谓非常用心,其他语言请自行触类旁通。

下面摘录部分规范原文

我在 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 ??_

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

不要锁住你的依赖项

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

Good ??

$ ls -la

package.json

Bad ??

$ ls -la

package.json
package-lock.json

函数长的比短的好

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

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

不要测试你的代码

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

避免代码风格统一

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

构建新项目不需要 README 文档

一开始我们就应该保持。

保存不必要的代码

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

以上规范,各位程序员务必遵守,并在团队内广为宣传(别说我教的),假以时日,必能收获最烂代码!

说点正事

如今的大型商业软件系统代码量巨大,早已不是凭借一人之力可以完成,当然程序员江湖中那些天才选手除外,比如:

Linux 之父 Linus Torvalds 一人写了初代 Linux 内核,微信之父张小龙一人写了 Foxmail 邮箱,求伯君一人完成WPS1.0

当然了,这些故事听听就好,这是大部分我等普通码农难以企及的高度。

工作拧螺丝是大部分程序员的工作常态,只是软件开发流水线中的一枚螺丝钉,如何协调螺丝钉造好大飞机?

答案是:代码规范

当然这里所说,是正经的好代码规范,团队遵循代码规范,更容易写出可读性高、易维护的代码,极大提高生产效率。

·················END·················

本文分享自微信公众号 - 编程学习基地(LearnBase)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2021-03-08

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 你见过最烂的代码长什么样子?

    经历了的项目越多,看过的奇葩代码也就越多。发现烂代码的目的并不是抨击和取笑,主要还是为了避免让自己或者身边的人写出类似的代码。

    范蠡
  • 你见过的最垃圾的代码是什么?

    文章转载自 OSCHINA 社区 [http://www.oschina.net]

    Java技术栈
  • 吐槽我见过的最烂的Java代码

    只针对spring框架,贴一份我见过最烂的代码(没有之一),我就想知道,有没有其他人能写出这样的代码?还有没有更加烂的编码方式?

    Java团长
  • 你见过最美的C语言代码是什么?

    有人会疑问了,这怎么算最美代码?其实,今天之所以写这篇文章,要从下面的这幅图说起,我们慢慢道来。

    7089bAt@PowerLi
  • 你见过“最美”的C语言代码是什么?

    我们都知道雷军雷布斯说过当时他写的代码像诗一样优美,那已经是三十年前的汇编时代了,那么现在你有见到过最美的c语言代码吗?

    李肖遥
  • 见过的最垃圾的代码,是怎么样的?

    某网友在 Hacker News 上发起了一个 “你见过的最糟糕的代码是什么? ” 的问题,引起了广泛关注和讨论,评论数已接近600条。

    芋道源码
  • 雷军26年前敲过的代码长什么样?

    大家都知道,小米科技的创始人雷军年轻时,也是一名程序员,而且一干就是10年。雷军在22年前的作文中写道:我会当一辈子程序员。

    老九君
  • 你知道小程序最后上线的代码是什么样子吗?

    我们知道小程序最开始出来的时候,包括到现在;官方给出的写法是js对应逻辑层,wxml也自己尝试了一套DSL自定义视图的模板语法,写法雷同vue的template...

    前端迷
  • 14W 行代码量的前端页面长什么样

    ? 作者:sigmaliu,腾讯文档 AlloyTeam 开发工程师 0. 前言 腾讯文档列表页在不久前经历了一次完全重构后,首屏速度其实已经是不错。但是我们...

    腾讯技术工程官方号

扫码关注云+社区

领取腾讯云代金券