垃圾代码书写准则（有意思）

沉默王二

发布于 2020-11-03 10:30:38

3720

发布于 2020-11-03 10:30:38

文章被收录于专栏：沉默王二

周日先唠唠嗑。早上起来刷朋友圈，发现小伙伴们都在说 S10 的事，忍不住思绪就飘了起来。我以前只玩单机游戏，因为。。。。。。难度低，看到这个原因小伙伴们是不是要感动地落泪了。

到苏州参加工作后，被宿友们带着玩了几把 DOTA，就彻底爱上了。一开始虐 AI，后来到对战平台上，叫什么名字竟然一时间忘记了。最高积分也就一千多来着吧，太菜了。

但是，不甘心啊。为了提升技战术水平，看了很多职业大神们的视频教学，比如说大酒神的“从零单排”，以及职业比赛的录像解说，最喜欢的战队是 LGD（老干爹），最喜欢的选手 ZSMJ（蛛丝马迹，或者叫左手摸即）。

再后来，DOTA2 出来了，界面和之前的 DOTA1 完全不同，就好像 Windows 7 和 Windows XP 吧。由于大局观、手操能力、天赋（零）等等各方面的原因，完全玩不了。

游戏玩得不 6，有时候也蛮叫人伤心的。

再后来，同学推荐我玩 LOL（英雄联盟），说操作性要求没那么高，我试玩了几把，确实还不错，最喜欢的一个英雄叫“暗夜猎手-薇恩”，射箭的，感觉动作很潇洒，身材也不错。

不过，终究是年纪大了（再次哭泣），本身在玩游戏上就零天赋，玩起来很吃力，经常被虐，虐到心塞，就渐渐地不玩了。

虽然不玩了，但经常关注 DOTA2 和 LOL 方面的消息。说句实在话，国内电竞选手的水平真的很优秀，出类拔萃的很多，但俱乐部经常有一些骚操作，就导致战队在国际赛事上的成绩一直不是很稳定。

作为一名心系电竞的老（菜） DOTAER，期待明年的 S11 吧。

嗑唠完了，给小伙伴们推荐一个非常有意思的 GitHub 项目：

https://github.com/trekhleb/state-of-the-art-shitcode

名叫“垃圾代码书写准则”，瞧这名字，我真的是服了。作者也是良苦用心，从反面教材的角度来阐述正确书写代码格式的重要性。

作者使用 JavaScript 编写的代码示例，我把它重制成了 Java 版，并且用我自己的语言风格翻译成了中文，希望小伙伴们能够喜欢。

? 以一种容易造成代码混淆的方式命名变量

命名越短，就需要越多的时间去思考代码逻辑等问题。

Good ??

int a = 42;

Bad ??

int age = 42;

? 变量/方法命名风格不统一

为风格不统一干杯。

Good ??

int wWidth = 640;
int w_height = 480;

Bad ??

int windowWidth = 640;
int windowHeight = 480;

? 不写注释

反正没人能读懂你的代码。

Good ??

int cdr = 700;

Bad ??

注释应该包含一些“为什么”，而不是一些“是什么”。如果代码连是“什么”都表达不清楚，那代码也太烂了。

// 700ms 的数量是从 UX A/B 测试结果中得到的一个经验值。
// @查看: <详细解释 700 的一个链接>
int callbackDebounceRate = 700;

? 使用母语写注释

如果你的母语是英语，那么请忽略这条准则。

Good ??

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

Bad ??

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

PS：如果英语书写能力不是很强的话，建议还是用母语吧。毕竟说清楚总比说不清楚要强。

? 声明变量的风格不统一

再次为风格不统一干杯。

Good ??

String [] i1 = {"沉", "默", "王", "二"};
String i2 [] = {"沉", "默", "王", "三"};

Bad ??

String [] wanger = {"沉", "默", "王", "二"};
String wangsan [] = {"沉", "默", "王", "三"};

? 尽可能把代码写成一行

Good ??

IntStream.range(1, 5).boxed().map(i -> { System.out.print("Happy Birthday "); if (i == 3) return "dear NAME"; else return "to You"; }).forEach(System.out::println);

Bad ??

for (int i = 1; i < 5; i++) {
    System.out.println("Happy Birthday " + (i == 3 ? "dear NAME" : "to you"));
}

? 对错误信息不管不顾

无论什么时候发现错误，都没有必要让其他人知道。

Good ??

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

Bad ??

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

? 使用大量的全局变量

全球化的原则。

Good ??

int x = 5;

void multi() {
  x = x * 2;
}

multi(); // 现在 x 是 10

Bad ??

int x = 5;

int multi(int num) {
  return num * 2;
}

x = multi(x); // 现在 x 是 10

? 声明根本不会使用的变量

万一以后用了呢？以备不时之需。

Good ??

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

Bad ??

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

? 如果条件允许的话，从不指定类型。

Good ??

// 享受便捷的快乐
List list = new ArrayList();
list.add("沉默王二");
list.add(18);

Bad ??

List<String> nameList = new ArrayList<String>();

// 编译出错
nameList.add(18);

? 没鸟用的代码

看起来更严谨，其实很多余。

Good ??

Integer multi(Object num) {
    if (!(num instanceof Integer)) {
        return null;
    } else if (num != null) {
        return (Integer) num * 2;
    }
    return null;
}

Bad ??

Integer multi(Object num) {
    if (num instanceof Integer) {
        return (Integer) num * 2;
    }
    return null;
}

? 大量的 if-else 嵌套

Good ??

void someMethod(int a, int b, int c) {
    if (a > 0) {
        if (b > 0) {
            if (c > 0) {
               int result = a / b / c;
            }
        }
    }
}

Bad ??

void someMethod1(int a, int b, int c) {
    if (a < 0 || b < 0 || c < 0) {
        return;
    }
    int result = a / b / c;
}

? 参差不齐地缩进

参差不齐乃幸福本源。

Good ??

String [] wanger = {"沉", 
        "默", "王", "二"};
String [] wangsan = {"沉", "默", "王", "三"};
Arrays.asList(wanger).stream().
        forEach(System.out::println);
Arrays.asList(wangsan).
        stream().
                forEach(System.out::println);

Bad ??

String [] wanger = {"沉", "默", "王", "二"};
String [] wangsan = {"沉", "默", "王", "三"};
Arrays.asList(wanger)
        .stream()
        .forEach(System.out::println);
Arrays.asList(wangsan)
        .stream()
        .forEach(System.out::println);