史上最糟糕的两个变量名(转)

 英文原文: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.

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

 

http://kb.cnblogs.com/page/153129/

时间: 2024-08-02 22:11:34

史上最糟糕的两个变量名(转)的相关文章

史上最糟糕的两个变量名

作为一个程序员,"起名字"是他们工作中非常重要的一部分.Phil Karlton就说过:"在计算机科学领域,有两大难题,如何验证缓存和如何给各种东西命名."虽然很难,但是每次在写代码的时候,给事物起名字又是不可 回避的工作.无论是程序变量名还是数据库表名或者是表里的列名,甚至是文件系统中的文件名,以及你的项目名称.产品名称,给这些东西起名字可不是个轻松活 儿. 糟糕的命名方式随处可见.你会发现,有的变量名字起得太短,根本没法提供足够的描述信息.或许有这个问题的人都做

站长网播报:OpenSSL重大漏洞详解 史上最糟糕的浏览器IE6死亡

中介交易 SEO诊断淘宝客 站长团购 云主机 技术大厅 1. 详解OpenSSL重大漏洞:谁会受影响?如何解决? 近日有研究人员公布,广为流行的网络加密软件OpenSSL存在名为Heartbleed的重大漏洞,人们的账号密码.信用卡号码等个人信息可能会失窃.各大主流网站都在加紧解决这一问题.究竟是什么回事呢?普通网民是否会受到影响呢?国外媒体近日就这类疑问一一进行了详解. 何为SSL? SSL是一流行的加密技术,可保护网络用户在互联网上传输的隐私信息.例如,访问诸如Gmail.com的安全网站时

问两个变量名

问题描述 一个是进货单明细里每行的进货价格一个是进货单总金额分别用哪两个单词好?(反对词霸查询来的国产结果) 解决方案 解决方案二:DAmountDPrice解决方案三:引用楼主qcrsoft的帖子: 一个是进货单明细里每行的进货价格一个是进货单总金额分别用哪两个单词好?(反对词霸查询来的国产结果) 我鄙视你,国产的怎么了啊>?解决方案四:unitPricetotalAmount解决方案五:单价英文unitprice那你就取UnitPrice就行了:英汉双向金融词典unitprice总金额弄成金

以黑客教主之名,TK 发现了 Windows 史上最大漏洞

有没有发觉,昨晚电脑突然被后台占用大量的带宽,导致网速变慢.这是Windows又在进行一次大规模的漏洞补丁更新.其中有两个高危漏洞,对windows95到windows10都会产生影响,几乎可以被认为是史上影响最广泛的windows漏洞. 可成功利用率非常高 这两个漏洞的发现者是"黑客教主"TK(TombKeeper),即腾讯玄武实验室创建者于旸.他将漏洞命名为"Bad Tunnel".Windows计划授予其5万美元的奖金. 以黑客教主之名,TK 发现了 Wind

史上最全正则

一个正则表达式测试(只可输入中文.字母和数字)       在项目中碰到了正则表达式的运用,正则还是非常强大的,不管什么编程语言,基本上都可以用到.之前在用java时特别是对用户名或密码使用正则非常爽,写脚本上用正则也非常爽,可是到了OC这却把我虐了一把,可能是对OC掌握的不够.这里就罗列了从网上找的很有用的资料,感谢大神们的贡献. 首先举一个例子: 匹配9-15个由字母/数字组成的字符串的正则表达式: NSString * regex = @"^[A-Za-z0-9]{9,15}$"

史上最全的机器学习资料(下)

推荐:史上最全的机器学习资料(上) 机器学习(Machine Learning, ML)是一门多领域交叉学科,涉及概率论.统计学.逼近论.凸分析.算法复杂度理论等多门学科.专门研究计算机怎样模拟或实现人类的学习行为,以获取新的知识或技能,重新组织已有的知识结构使之不断改善自身的性能.机器学习牵涉的编程语言十分之广,包括了MATLAB.Julia.R.Perl.Python.Clojure.Ruby等等. 为了让开发者更加广泛.深入地了解机器学习,组织翻译了GitHub Awesome Machi

史上最全的PHP正则表达式(手机号需要加上177-***)

首先看下正则表达式思维导图: 一.校验数字的表达式 1 数字: ^[0-9]*$ 2 n位的数字: ^\d{n}$ 3 至少n位的数字: ^\d{n,}$ 4 m-n位的数字: ^\d{m,n}$ 5 零和非零开头的数字: ^(0|[1-9][0-9]*)$ 6 非零开头的最多带两位小数的数字: ^([1-9][0-9]*)+(.[0-9]{1,2})?$ 7 带1-2位小数的正数或负数: ^(\-)?\d+(\.\d{1,2})?$ 8 正数.负数.和小数: ^(\-|\+)?\d+(\.\d

史上反侦察力最强木马“隐魂”:撑起色情播放器百万推广陷阱

本文讲的是史上反侦察力最强木马"隐魂":撑起色情播放器百万推广陷阱,近期,360安全中心紧急预警了一款感染MBR(磁盘主引导记录)的"隐魂"木马,该木马捆绑在大量色情播放器的安装包中诱导网民下载,入侵后劫持浏览器主页并安插后门实现远程控制.据统计,短短两周内,"隐魂"木马的攻击量已达上百万次,是迄今传播速度最快的MBR木马. 与疯狂的肆虐趋势相对应的,是"隐魂"木马超高的反侦察能力和极其复杂的制作技术: 从感染方式上来说,不同

史上最难的面试谜题

史上最难的面试谜题 你曾经在应聘一份编程工作的面试中被问及一些解谜类的问题吗?反正我碰到过.我被问到的那个问题是: 你最喜欢的那个牌子的苏打,有多少是在这个州被消费的? 拜托,正确的答案不能是"关我什么事",除非你不想得到这份工作了.我当时对这个问题毫无头绪,后来才知道这是一个"费米 问题"(Fermi Question). 谜题作为一种新生事物,在20世纪90年代的程序员面试里风靡一时.这在<如何移动富士山?>(<How Would You Mo