转载

请停止写“烂”代码！

【51CTO.com快译】作为一名在校教师，我的工作就是不断审查学生们编写的代码。

请停止写“烂”代码！

这里我不想取笑任何人，因此所有实例皆以匿名形式公布，单纯希望大家能够从中获得启示。闲言少叙，咱们先来看一个奇妙的例子：

if(a<8&&b<8&&c<8)
a = 8;b=8;c=8;

大家不妨看看其中的错误在哪。

怎么样，大家发现了多少问题？

我们先对其进行分析。最惹眼的肯定是“if”的密度。其中的三项条件之间没有用空格隔开。由于&运算符跟8相邻，因此很容易让人看花眼。这就是问题之一，空格。大家最好在代码内容间加上空格，包括各语句之间、运算符之前与之后。下面我们对其进行重写：

if(a < 8 && b < 8 && c < 8)

很明显，现在看起来好多了。

问题二

有过编程经验的朋友对“魔数”肯定有着深刻印象。魔数是指那些直接出现在代码当中，不会自我描述且对于阅读者而言毫无意义的数字。如果大家对于“8”这个数字没有什么特别的负面感觉，那可以肯定您的编程从业时间并不长。这里欢迎大家来猜猜这个数字的含义。由于正是我本人给学生们布置的作业，所以我很清楚这里“8”的意义（代表的是工人下班的最早时间），但对他人来说则很难猜。更糟糕的是，数字“8”在这段代码中重复编写了6次，意味着如果我们要将其换成7，则需要多次修改并反复查看以确认没有漏掉某个“8”。

解决方案当然是使用常量。这里我们可以定义一条常量：

finalint EARLIEST_HOUR = 8;

现在代码变成了这样：

if(a < EARLIEST_HOUR && b < EARLIEST_HOUR && c < EARLIEST_HOUR)
a = EARLIEST_HOUR; b = EARLIEST_HOUR; c = EARLIEST_HOUR;

接下来看看代码中的语义：这段代码到底要实现什么效果？现在有了常数，看起来应该更为清楚。“if”负责测试三个变量，a、b与c。如果三个变量的值全面小于8，则全部获得最早时间值分配。这类测试非常常见且能够防止非法输入状况。然而，让我们再来看看if本体——如果条件为真，哪行代码会执行if结果？

在开始之前，我们首先要强调一点，Java是会直接忽略空格的。这意味着就编译器而言，我们可以随意使用空格但并非强制性（当然，我们必须至少在两个词之间添加一个空格，但仅此而已）。这同时意味着Java中的语句会在编译器发现“;”符号时终止，而非在行末自动终止。现在再来看看以上代码。其全部写在一行当中。由于这位同学在行前加了个“tab”，因此可以确定这一行属于“if”语句。不过问题仍然存在——if的本体究竟是什么？以下为答案，if的本体是：

if(a < EARLIEST_HOUR && b < EARLIEST_HOUR && c < EARLIEST_HOUR)

a = EARLIEST_HOUR; b = EARLIEST_HOUR; c = EARLIEST_HOUR;

就是这样，只有“a”属于条件本体。那么语句剩下的部分呢？它们对于“if”毫无意义，意味着其无论条件是否为真都会被执行。如果这位学生认为条件为真时三项分配会被全部执行，那他就犯下了一个严重的逻辑错误——代码不可能实现这样的效果，但却很难看得出现。

另外，我们还发现了另外两个问题：

问题三——条件为真时只有一次分配能够切实执行，而这与程序员的预期不符。

问题四——将太多语句写进同一行是种坏习惯。这并不是错误，Java允许这种作法，但其会干扰我们的审查与判断。

下面来看正确的代码编写方式：