您当前的位置 » 主页 > 文章中心 > 业界新闻 > 把代码写得如注释般清晰,简洁

把代码写得如注释般清晰,简洁

[上一篇] [下一篇] 查看更多…… 时间:2010-09-21 09:34   来源:网络   作者:佚名   点击:

百姓网CEO王建硕最近写了一篇博文《我们不喜欢注释》,在博文中他表示我们不喜欢过多的注释,我们要让代码写得入如注释般清晰,简洁,让人可以如读英文文章一样的读代码,而不是读注释。现把本博文转载如此,全文如下:

今天下午的乐高,讨论了代码规范中注释的部分。做为实用主义者,我们不喜欢过多的注释。“让代码的速度跟得上思考的速度”是我们一直提倡和追求的,也就是代码要写得如注释般清晰,简洁,让人可以如读英文文章一样的读代码,而不是读注释。

我们干掉了所有PHPDoc才认识的东西,就是/** @param这样的东西,,另外注释统一了用两个斜杠(//),而不用斜杠星号(/*...*/),以强化就算有,也要短到一行的意思。

当我们强调注释或者文档的时候,或许是在解决错误的问题。越长的注释,就意味着越过期的注释。

我们反对过度文档,而尽量用最简洁的代码来取代它。与其在注释上花功夫,不如在函数和变量的命名上多推敲,花时间多做重构,把分层和封装做好,把抽象做好。

“没有比提高一个没有必要的事情的效率更没有效率的事情了。”一次一次在开发过程中被验证。

说到底,写代码如同写文章,有十几种不同的写法,无非在“推”和“敲”两个都不错的字中寻求最佳的那一个,或者在一个恶心的A和一个恶心的B之间徘徊,绞尽脑汁寻找一个不是那么恶心的C。说到底,没有绝对的对和错,只有合适与不合适。一群人,在一起磨合出来一种共同的思路,才是有力量的开发团队,否则只是乌合之众。

(责任编辑:Martin)
TAG:  
 上一篇: 谷歌开源系统盈利模式话题再度激活
 下一篇: 施密特:微软目前是谷歌最大对手

等等,下面还有精彩的文章哟:

发表评论 进入详细评论页>>
用户名:  验证码:点击我更换图片



  作品展示文章中心站内下载艺术设计案例中心服务内容业务流程留言咨询
COPYRIGHT @ 2009-2012 MartinStudio ALL RIGHTS RESERVED. Powered by DEDECMS 沪ICP备12028012号-1 网站安全检测平台