注释不能美化糟糕的代码 带有少量注释的整洁而有表达力的代码,要比带着大量零碎注释而复杂的代码好得多
换做是我,也会毫不犹豫选择第二种方式,能够用代码阐述地尽可能避免 多 余的注释。当然也并不是说,没有注释更好,有些注释是必不可少的, 是有利的,如涉及到法律信息的,需要在源文件头部都加上相关信息的注 释。注释可以为我们的返回值增加说明,但是同样的我们尽可能可以使用 表达力强的函数名,也可以解决,这个时候显得注释就是多余的了。
坏注释 多余的注释徒增阅读者的压力,本身简单的函数或者变量名等,就不需要过多的注释去说明。一个函数的注释,很有可能随着时间的迁移,在下一位改动函数内部的人,很有可能就会因为其增加减少的代码而改变了注释的初衷,这时候注释带有很强的误导性了。用好注释,很多时候,需要开发人员及时的维护,这样才能保证注释的准确性以及它存在的价值。
小总结
其实我最大的感触是:尽可能选取表达力好的名字,名力能表其义,减少不必要的注释,让代码的表达力提高减少注释带来的风险。
网友评论