标签 Blogger 下的文章

只对代码无法表达的东西写注释

本文翻译自”Comments Only What the Code Cannot Say“,来自于《程序员应该知道的97件事》一书中的某个章节。

我们知道理论与实践之间存在差异。在实践中,这个差异远大于其在理论中所描述的那样 – 一份对注释(comments)的观察数据也证实了这一点。理论上,通常的注释代码的想法听起来是值得的:它可以为读者提供更多的细节,可以解释发生了什么事情。有什么能比自我帮助更具可帮助性的呢?然而在实践中,注释却经常变成一个破坏因素。与其他书面形式一样,编写好的注释也是有技巧的。这个技巧的主要内容是知道何时不写注释。

如果代码书写得不合乎语法规范,那么编译器、解释器以及其他一些工具会提出异议。如果代码在某方面功能不正确,评审、静态分析、测试以及在产品环境下的日常使用会发现绝大多数Bug。然而对于注释呢?在《The Elements of Programming Style》一书中KernighanPlauger曾指出“如果注释是错误的,那么它带来的价值就是零(甚至是负值)”。可是就是这样的注释却经常以一种编码错误所不能的方式散布并存活于代码库中。它们会持续不断地分散你的注意力,提供误导信息,细微但却持续地影响着程序员的思维。

那些在技术上没错,但却没有给代码带来任何价值的注释怎么样呢?这类注释简直就是噪音。重复描述代码含义的注释没有为读者提供任何额外价值 – 先用代码表达,再用自然语言复述不能让其看起来更加真实。被注释掉的代码不是可执行代码,所以无论对读者还是对代码运行时它都无法起到任何有用的效果。它自身也会很快地变得陈旧。版本相关的注释以及被注释掉的代码试图解决有关代码版本和历史的问题。但这些问题已经被版本控制工具(更加有效地)解决了。

代码库中普遍存在的噪音类注释以及错误注释助长了程序员们忽略所有注释的行为,他们要么略过注释,要么采取积极措施将注释隐藏起来。程序员是足智多谋的,他们会绕过任何被认为可能会造成破坏的事物:将注释折叠起来;更换颜色样式,使得注释的颜色与背景色相同;编写脚本过滤掉注释。为了使代码库免遭程序员们滥用聪明才智所带来的破坏,降低因忽视真正有价值的注释所带来的风险,我们应该像看待代码那样看待注释。每条注释都应该为读者带来一些价值,否则这些注释就是无用的,应该被删除或重写。

那么,什么才是有价值的呢?注释应该表达那些代码没有表达以及无法表达的东西。如果一段注释被用于解释一些本应该由这段代码自己表达的东西,我们就应该将这段注释看成一个改变代码结构或编码惯例直至代码可以自我表达的信号。我们重命名那些糟糕的方法和类名,而不是去修补。我们选择将长函数中的一些代码段抽取出来形成一些小函数,这些小函数的名字可以表述原代码段的意图,而不是对这些代码段进行注释。尽可能的通过代码进行表达。你通过代码所能表达的和你想要表达的所有事情之间的差额将为注释提供了一个合理的候选使用场合。对那些代码无法表达的东西进行注释,而不要仅简单地注释那些代码没有表达的东西。

By Kevlin Henney

Ubuntu一年使用感受

今天是Ubuntu 11.04版本(Natty Narwhal)发布的正日子!想必全世界的Ubuntu Fans们都会或多或少的兴奋上一阵儿。我接触Ubuntu这个Linux发行版较早,甚至可以追溯到Ubuntu 5.10。不过真正将Ubuntu作为我日常工作学习的第一操作系统还是在去年Ubuntu 10.04LTS版本发布之后。从那时起到现在整整有近一年时间了。这里我也来说说这一年来使用Ubuntu的感受。

初次使用Ubuntu的朋友可能都会被问到以下问题:

·你的Windows系统很奇怪啊,咋和我的不太一样呢?

·你用的是苹果操作系统吗?

·你为何不用Windows操作系统了呢?

·Ubuntu比Windows好在哪里呢?

实话实说,我接触Linux的初衷就是好奇。用惯了Windows,总想换个新鲜的环境。也许与我有类似想法的人会有不少。至于Windows和Ubuntu哪个更好?我倒是觉得没啥可比较的。两者诞生的背景不同、创造者集体认同的文化不同、设计思想的聚焦也不相同。非要将两者在个人电脑桌面领域分出一个高下未免有些狭隘。从全局来看,两者既是竞争对手,同时也可以相互补充。关键在于你的需求以及你对两个系统背后文化的认同。如果你只是使用过其中一种系统的话,那你就更没有发言权了。你没有深入地使用过Linux,你又怎么能体会到其背后的文化内涵呢!至于媒体上所宣传的Linux免费、病毒少以及比Windows安全等等特性,我觉得对于普通中国人来说,这些都不能构成实际的吸引力,却颇有些噱头的意思在里面,至少免费这一项在大陆是不成立的,具体原因你是懂的。

Linux是大势所趋,这里倒不是针对桌面领域,而是其全局竞争力,是指对整个IT产业的影响。前不久Linux也刚刚过完自己20周岁的生日。媒体一致认为Linux已经战胜了Windows,观点依旧片面,但不可否认的是Linux已经渗透到了整个行业的各个角落,这个是桌面老大Windows所无法比拟的。想像一下:全世界的有多少数据中心的节点上跑的是某个Linux发行版或自定制版的Linux版本,而又有多少个节点跑的是Microsoft的Windows Server呢?恐怕只有Microsoft自己的数据中心有吧。在嵌入式领域Linux更是独领风骚。

有些跑题了,我们言归正传,说Ubuntu的使用感受。如果说目前的Ubuntu在桌面领域已经超越了Windows,那肯定是谎话。实际上的情况是与桌面老大Windows相比,号称最流行的Linux桌面发行版的Ubuntu依旧有着很大差距。当然这些差距是可以理解的。毕竟Windows是在一个庞大的商业帝国下面由成千上万的精英花了十多年专职打造出来的,而Ubuntu则只是一个Linux发行版而已。按Eric S.Raymond的观点:前者是大教堂中的产物,后者则是集市中人们智慧的结晶。

在使用Ubuntu 10.04的过程中积累以下使用感受:

1、Ubuntu系统兼容性差

可以明确地告诉你:不是所有机器都可以成功安装Ubuntu的,有些时候你费了九牛二虎之力,也只能无奈的退回到以前的系统。虽然我自己没有遇到这种情况(我的机器乃是ThinkPad X60),但是耳闻目睹的失败案例倒有不少。

2、Ubuntu并没有想像中的那么稳定和可靠。 

我们在使用Windows时偶尔会遇到蓝屏,这样的场景我在Ubuntu下也时有发生。有些时候运行一些桌面应用也会导致桌面系统崩溃。

3、缺少厂商积极的驱动支持

很多Linux自带的驱动程序都不是相应设备厂商提供的,这样会导致设备性能无法发挥到最优。另外新设备的驱动无法及时提供会导致这些设备在Ubuntu下无法使用。

4、升级风险较大

这个我还是有亲身体会的。在10.04之后,我曾经多次升级过内核,从2.6.32-24到2.6.32-27再到2.6.32-30,每次升级后系统总会有些奇怪的问题发生:比如无线路由升级后频繁断连、窗口切换变得迟钝等等。虽然之前发布过10.10版本,但是我尚未敢尝试直接升级,因为社区里的很多人反映升级后系统无法启动或启动后出现各种故障或某些设备无法使用等情况。

5、残留的Bug不少

虽说Windows发行版也有诸多Bug,不过Ubuntu有一些严重的问题,比如休眠根本无法使用、启动应用程序的记录注销前会话功能无法取消等等。

6、优质桌面应用相对匮乏

现有的桌面应用的表现(性能、美观和易用性)尚无法与Windows上的一些知名应用相提并论。比如Ubuntu下的OpenOffice很是让人失望,让我不得不开始怀念起Ms Office。

到这里你也许会问:怎么都是糟糕的体验呢?那Ubuntu就没啥优点了吗?不是这样的。Ubuntu专有特性你可以参考Ubuntu官方的宣传文档。而我想说的是Ubuntu或Linux最大的优点就是其开放性以及其尚不完善的状态。开放性让你可以深入挖掘到Linux背后的任何一个细节并作出你的修改;另外正是由于其不完善,作为程序员的我们才有了用武之地,不是吗!

通过这一年来的使用,我发现Ubuntu真正进入大众生活还为时尚早,即使以后做到了,可能最终也无法达到Windows或Apple的Mac OS在个人电脑桌面领域所达到的高度。不过对于一名程序员来说,Ubuntu或任何一个其他Linux发行版却是极其适宜的,你可以按照你的想法掌控一切,不过前提是你要花费一些时间和精力去挖掘Ubuntu、挖掘Linux。

Ubuntu不是这个世界上唯一的Linux发行版。使用Ubuntu是自发的,放弃Ubuntu也是自发的。如果你不认同Ubuntu演进计划,你大可尝试一下其他发行版,比如FedoraArchOpenSuse等。使用Ubuntu的人都是有一些Geek精神的,所以转到其他Linux发行版也不是什么新鲜事。

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats