程序员令人笑喷的代码注释,测试部:下班留下来谈谈!

PHP自学 / 2019-01-02 18:56:23

小编先说一件真事,以前在公司的时候,有一位技术非常牛逼的前辈,在代码注释中写了“说了你也听不懂!垃圾”,这不是重点,重点是他下意识的把这句话复制到了弹框提示的文字中,用来测试一个代码的逻辑性,后来忘了删除。代码也提交到了测试部,巧的是在bug系统发现了这个bug,bug弹出了“说了你也听不懂!垃圾”,最后被测试部的大佬邀请喝公办茶。

个人观点,只是经验之谈,欢迎来喷 !

1、在类级别,方法级别上最好加上注释。

特别是那些逻辑复杂的,难以用一句话描述清楚的内容,最好加上注释,讲清楚这个类,或这个方法是用来干嘛的,有什么需要注意的地方。这个注释很重要,特别是这些代码还要被其他人使用的时候,加上说明会方便很多。

2、在某些容易留坑的地方,最好加上注释。

这种地方很多时候是因为图省事,或者没时间等原因,只能暂时这么做,但是需要提醒使用者注意。或者怀疑队友水平没那么高,理解不了你的代码,某天来修改代码并且容易改错。或者是因为这段代码『特立独行』,不是按照常规方式,你自己在这里耍了小聪明,或者用了自己设计的一些技巧性的东西,怕别人看不懂。

3、涉及到业务逻辑的代码,比如某些字段需要加说明,之类的。

有些业务的东西,确实不是一两句代码就能扯清楚的,这种东西,加个注释就好了。

4、因为修复某个bug而加进去的代码。

改bug,特别是改别人的bug的时候,如果不是进行大规模的重构,而是往里面加小段代码打补丁的时候,最好加上注释,否则这段代码很奇怪,并且容易看不懂。记住最好留上你的名字,不然后人看这个代码都不知道该去骂谁,hiahiahia~。