摘要: 看了一篇博文《我为什么拒绝写注释》 ,看了回帖,反对声音一边倒。但我和作者深有共鸣,于是写一篇博文以示声援。注释本质上是另一种形式的文档,当我们来讨论注释的必要性的时,其实就是在讨论文档的必要性。注释和文档确实可以带给我们一些收益,但使用不当却会带来很多的麻烦.1.可运行的代码是唯一正确反映现实的东西。需求是易变的,因此软件也是易变的,但是绝大多数公司/团队都没有精力和财力来及时的更新文档和注释,因此越到项目后期,就会越会出现注释(文档)和代码不一致的情况。于是程序中充满了虚假的注释和谎言。2.当你需要用注释来说明自己的算法和意图的时候,停下来想一想,很多时候你会发现自己的设计出了问题。很少会 阅读全文
posted @ 2011-05-25 17:07 张旭光 阅读(501) 评论(3) 推荐(1) 编辑