那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

在公司的时候,曾经有一位技术很牛的前辈,在代码中的注释上写了一句“测个毛”,这不是重点,重点是他把这句话粘到了弹出框的文字上,自己测试一下代码逻辑,就随意打了这三个字,结果提交代码忘记修改了,后来在bug系统发现了这个bug,并得到了测试部老大的亲情问候。

想学习web前端找工作这里推荐一下我的学习交流q.u,n: 95694,

0552 ,里面都是学习前端的。

       如果你想制作酷炫的网页,想学习编程。自己整理了-份201 8最全面前端学习资料,从最基础的HTML+CSS+JS [炫酷特效,游戏,插件封装,设计模式]到移动端HTML5的项目实战的学习资料都有整理,送给每一位前端小伙伴, 有想学习web前端的,或是转行,或是大学生,还有工作中想提升自己能力的,正在学习的小伙伴欢迎加入学习。

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

那些令人喷饭的代码注释,最底下的那个让我笑出了声!

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

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

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

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

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

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

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

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

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

猜你喜欢

转载自blog.csdn.net/weixin_43955769/article/details/84898310
今日推荐