重构代码之3-注释

写这篇博客的时候就在想,如果写注释会不会影响代码的质量呢?会不会影响自己对代码的仔细斟酌不知道,但是可以肯定的一点是,就算你写了注释肯定不会为你糟糕的代码加分的。所以就我个人而言我是不太喜欢写注释的。

凡事无绝对,有些注释是必须存在在那里的,比如法律信息;某个抽象方法返回值的解释;解释接下来的意图,让读者了解你想要干什么;为某个返回值阐述用途(看过前几篇博客的同学可能会说,不是要让参数和返回值自身能够说清楚吗?)其实有的时候可能你手头的代码是某个标准库的一部分,或者它是不能被修改的,这个时候你需要注释来帮助你记忆和理解;测试代码,警告(比如说:以下的代码不要运行,除非你有大量的时候去kill掉启动的那些线程),Todo代码,Javadoc。这些例子中出现注释总归会好一点,让人清晰且舒服。

同样凡事无绝对,有些地方还是别写注释的好,举个tomcat的例子:


我就不理解了,变量名已经清晰到极致了,干嘛要搞出个注释呢,实在没有意义啊

误导性的注释千万不要写,如果你知道自己不会维护也千万不要写,不然就会出现代码改了千万手了,注释还是beta版本的。还有就是想上面的例子,这种废话注释就不要写了,日志里面不要写注释,写好你的业务节点就好了,有些人还习惯做位置标记 比如://///////////////********////////////////, 其实就是一点,能用函数名,变量名说明的问题就不要去写注释,不写注释真的会提高你的代码能力。

不得不提的一个 就是有很多人喜欢注释代码,个人觉得代码有用就留着,没用就删除,您留这个注释的代码干嘛啊?如果我有幸维护您的代码,你说我是删除这个段代码还是留着? 用膝盖想我也不可能删除吧,留着大面积注释的代码,真是头疼。

 

特别提醒一下效率优化的开发者,如果代码中用到了算法,这个是一定要写好注释去解释说明的,可以是算法名,如果算法是你自己发明的那就一定要写清楚这个算法,或者写清楚如何使用,降低调用者的阅读成本。

 

ok,就写到这里吧,中秋快乐,吃了月饼重构代码吧哈哈哈。
 

猜你喜欢

转载自himichaelchu.iteye.com/blog/2114080