No Comment

At Microsoft, every line of production code gets reviewed by an often more experienced engineer before check-in. Any one can comments on other people's code, raise issues and report defects. Every one learns during this process, which improves product quality and make people better programmers. -- FengYuan@MS

之前我也认为代码的注释非常重要,但是后来发现事实并不是这样。

1、首先,代码是programmer( or coder)之间沟通的最好语言,而注释往往带来歧义,更何况大多数programmer往往文笔不佳,词不达意。
2、其次,fuzy code fuzy comment,xxx编写的代码晦涩难懂,他写出来的注释难道就能读懂?
3、有注释才能让人读懂的代码本身就存在着bad smell,这个问题需要通过重构来解决,注释只是掩饰不足的方法。
4、逻辑结构和命名规则好的代码不需要注释。在进行codereview的时候,应该更着重于检查逻辑结构和命名规则,而不是走形式般的只看代码行注释率。

p.s.
中学学古文的时候曾经用过一种上面一行古文,接下来一句白话文翻译的辅助教材,什么时候碰到代码和注释的形成这种格局的代码,那才叫恐怖!我想TerryLee兄可能有更深刻的体验把

posted @ 2006-03-17 00:38  海南K.K  阅读(1307)  评论(0编辑  收藏  举报