我爱我老婆

代码即是注释

有些开发人员喜欢在代码中写大量的注释,认为这样可以增加代码的可读性,而很多大牛却也很少写,之前也是不解。

 

大量的注释的确可以帮助读代码的人,更快得理解,但往往增加了我们的关注点,代码看起来也不漂亮,Jobs告诉了我,什么才是最美? 是简约之美...

 

又想增加代码的可读性,又想减少甚至不用注释,这是个矛盾嘛,像是一道永远无解的数字游戏,最近有些感悟,找到了答案:

 

思想:

类名,方法名,属性名,变量名,即是注释,无处不是注释,无论一个业务多复杂的系统,只要设计合理了,处处井井有条了,即使没有一行注释,代码读起来也是很清晰,漂亮。

 

方法论:

当你有冲动要加点注释的时候,先问下自己,要描述的逻辑是否可以封装成方法,方法名以要写的注释命名。

再思考这个方法放到当前文件是否合适,是否便于维护。

posted @ 2011-11-30 10:04  DataFlow  阅读(546)  评论(0编辑  收藏  举报