那些令人喷饭的代码注释，最后一个让我笑出了声！

Posted 2022-12-06 会Python的程序媛

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

“我自己是一名从事了5年前端的老程序员，辞职目前在做讲师，今年年初我花了一个月整理了一份最适合2019年学习的web前端干货，从最基础的html+CSS+JS到移动端HTML5到各种框架都有整理，送给每一位前端小伙伴，web前端学习群957389100，这里是小白聚集地，欢迎初学和进阶中的小伙伴。

个人观点，只是经验之谈，欢迎来喷 ！

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

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

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

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

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

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

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

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