史上最糟糕的两个变量名

　　英文原文：The world’s two worst variable names

　　作为一个程序员，“起名字”是他们工作中非常重要的一部分。Phil Karlton就说过：“在计算机科学领域，有两大难题，如何让缓存失效(cache invalidation)和如何给各种东西命名。”虽然很难，但是每次在写代码的时候，命名又是不可回避的工作。无论是程序变量名还是数据库表名或者是表里的列名，甚至是文件系统中的文件名，以及你的项目名称、产品名称，给这些东西起名字可不是个轻松活儿。

　　糟糕的命名方式随处可见。你会发现，有的变量名字起得太短，根本没法提供足够的描述信息。或许有这个问题的人都做过TRS-80 BASIC程序员，在这种BASIC语言里，无论你起多长的变量名，只有名字的头两个字母有效，所以那个时候的程序员不得不在键盘边儿上放个笔记本，以便将很短的变量名称和他们的对应含义记录下来，这样才能不搞混淆。

　　有的时候，你会发现这样的命名方法：直接将变量名称中的原音字母省略，以此来缩短变量的长度。这种方法被用来替代常用的“截断法”，也就是简单地把字母截断来缩短长度。比如你可以用$cstmr(原音省略)来代替$cust(直接截断). 但是，对于customers（顾客）和costumers（服装提供商）这两个单词来说，原音省略法就会造成混淆(customers和costumers采用原音省略法，其结果都是cstmr)。更糟糕的是，$cstmr缺乏原音字母，打字的时候会更加别扭，而且从读音的角度来说，也很难对其进行发音。

TSR80计算机，只支持4位的变量名

　　还有一种人为的特殊命名方式，有的时候程序的作者只是为了小幽一默，所以起了些有趣的名字。我就曾经见到过有人把循环变量命名为$crap (crap在英语里是轻微的咒骂，跟damm, shit这种词语差不多——译者注)，我的一个同事告诉我，他在给一段代码做整理的时候，看到过有个函数被命名为: THE_LONE_RANGER_RIDES_AGAIN() 。虽然这样的命名方式非常特殊，但是他们并不属于我说的“糟糕”的命名的范畴。

　　虽然我很清楚，对于命名规范这种事情，大家是公说公有理，婆说婆有理，但是，我还是非常自信地宣布，我认为，史上最糟糕的命名是：$data!

　　是的！必须是$data! 这个命名完全是循环定义，实际上就是一句废话。就仿佛你把你们家所有的东西都扔到一个行李箱里，然后在行李箱上面贴个条，赫然写着：“东西”。

　　正确变量命名应该写清楚变量的数据类型。因此在命名时考虑数据类型是一个很好的提升命名质量的办法。我有一次在看一段读数据库表记录的代码时，看到了$data这个名字，大概像下面这样：

$data = read_record(); 
print "ID = ", $data["CUSTOMER_ID"];

　　如果这时候问问：“$data是什么数据类型呢？”，然后你就很想给它换个名字了。把名字改成$record是一个好的开始。进一步改成$custormer_record，就更好一些了。

　　模糊的命名相当糟糕，糟糕程度紧随其后的就是，长得几乎一样，无法分辨的变量名。因此，有史以来第二糟糕的变量名就是: $data2.

　　总的来说，任何仅仅依靠数字编号来区分的变量名都应该被重构。马上举个例子给你看，你就明白了：

$total = $price * $qty; 
$total2 = $total - $discount; 
$total2 += $total2 * $taxrate; 
$total3 = $purchase_order_value + $available_credit; 
if ( $total2 < $total3 ) { 
    print "You can't afford this order."; 
}

　　你可以发现，要读懂这个代码就跟读甲骨文一样痛苦。很明显，这个程序的目的就是要计算订单的总花费 — $total. 如果程序的逻辑没有问题，那么$total这个变量名也算是恰如其分。但是，偏偏有人修改了这个程序，给添加了计算折扣和税率的功能，然后他还在变量命名上偷懒，直接起了个$total2, 更可恨的是，还有其他人在这个程序里计算了用户的可用账户金额，然后直接起名叫 $total3 !

　　真正倒霉催的是下面这行代码：

if ( $total2 < $total3 )

　　如果你不回头看之前的代码，要想知道这句代码的意义是完全不可能的。所以你必须往回阅读，看看那个变量究竟是什么意思。

　　如果你看到了类似像$total2这样的变量，那就应该把这个名字改得更加具体一些。花5分钟的时间让这些变量名称变得更加合理。这个层面上的软件重构是最简单，代价最小，也是最安全的，尤其是在你要修改的变量是个局部变量的时候。

　　让我们用最简单的“搜索-替换”功能来解决我们之前发现的问题

$order_total = $price * $qty; 
$payable_total = $order_total - $discount; 
$payable_total += $payable_total * $taxrate; 
$available_funds = $purchase_order_value + $available_credit; 
if ( $payable_total < $available_funds ) { 
    print "You can't afford this order."; 
}

　　经过修改后，唯一变化的就是变量名，而且代码变得简单易懂了。现在对于每个_total，就不存在二义性的问题了。看看我们发现了什么：原先if语句中的两个比较变量的位置写反了。有效的命名方法让我们能够更快地发现错误。

　　通常，我们都认为用数字作为变量的结尾是不好的命名方法，但是有一个例外。如果变量描述的实体本身就是以数字结尾的，那变量名最好也是以数字结尾。比如，如果我们要定义一个HA-1哈希实体，那干脆就把它命名为$sha1, 这样就很好，你完全没有必要把它搞成sha_one，然后来避免在变量名中使用数字。

　　在我完成了对本文的第一版后，我创立了自己的命名规则，并使用Perl::Critic包来检测上述提到的两种命名问题。我制作的插件Perl::Critic::Bangs可以检测出这两种问题：ProhibitVagueNames和ProhibitNumberNames.

　　还有哪些其他的糟糕的命名方法逼得你发疯？你自己有去做些什么纠正这些错误么？

　　编译：伯乐在线 – 黄小非