天下间的父母都会认为自己的孩子是好孩子,但是事实……
什么样的注释是坏注释,什么样的注释是我们需要尽力避免的?
自己对程序的喃喃自语==废话+误导
如果要写注释,那就写切题的,就要写好的,不要随意的去写,因为注释是大家看的,不是你自己一个看的。只有你自己才能看懂你自己的喃喃自语,或许日子久了,你自己也看不懂了,更别提大家了。
废话型注释
非常明显的东西,你还要加一堆注释,比如这是一个if语句,这抛出一个什么类型的异常,
/**The name.**/
private String name;
/**The version.**/
private String version;
/**The day of the month.**/
private int dayOfMonth;
多余的注释,误导性的注释
程序猿有时候在码代码的时候,会出现老注释的情况,就是方法的实现意图已经修改了,而注释却没有修改,结果就造成了,在阅读代码注释的时候发现代码和注释驴头不对马嘴。更严重的就是当老代码的注释和新代码还有那么一点点关联的时候,造成的误导,会让读代码的人原地爆炸。
日志型的注释
在进行代码修改的时候,把每次的修改意图,修改的东西全部当成注释写在类和方法的注释中。
我的天,要这种东西干嘛?让gitHub做呀,你是不是看不起我gitHub?
位置标记
// Actions /////////////////////
别做这个位置标记的,多余~
注释代码
Excuse me ?
对于无用的代码,删掉删掉删掉(重要的事情说三遍)
对于过时的方法,别直接删别直接删别直接删(重要的事情说三遍@Deprecation)
今天就到这里了,明天再见。