代码改变世界

代码的注释

2010-03-27 14:14  xiaosonl  阅读(852)  评论(2编辑  收藏  举报

这几年来看过一些有关编码实践的书和文章,发现一个规律:

国人的建议大多要求注释详尽,让代码更易读易懂;而老外的建议几乎是尽可能的少,比如只写一些作者意图类的,或代码本身无法直接表达的意思。

这种区别,一方面是大概是国人编码水平不如老外,需要注释来弥补可读性;另一方面,就是代码是用英语来写的,这个是很重要的。虽说代码写的好,可以写的像自然语言一样易懂,可是再自然也还是英语,对于国人普通英文水平较差的程序员而言,还是很不直观的。所以国人要写详尽的注释,来弥补语言文字的理解难度。

举个例子,比如大家方法名都用中文,那么注释量应该能降低不少。