真事儿，在公司的时候，曾经有一位技术很牛的前辈，在代码中的注释上写了一句“测个毛”，这不是重点，重点是他把这句话粘到了弹出框的文字上，自己测试一下代码逻辑，就随意打了这三个字，结果提交代码忘记修改了，后来在bug系统发现了这个bug，并得到了测试部老大的问候。
如果有想学习java的程序员，可以来我们的java学习群：8184，64711免费送java的视频教程噢！小编是一名5年java开发经验的全栈工程师，整理了一份适合18年学习的java干货，送给每一位想学的小伙伴，欢迎大家一起学习哦。
个人观点，只是经验之谈，欢迎来喷 ！
1、在类级别，方法级别上最好加上注释。
特别是那些逻辑复杂的，难以用一句话描述清楚的内容，最好加上注释，讲清楚这个类，或这个方法是用来干嘛的，有什么需要注意的地方。这个注释很重要，特别是这些代码还要被其他人使用的时候，加上说明会方便很多。
2、在某些容易留坑的地方，最好加上注释。
这种地方很多时候是因为图省事，或者没时间等原因，只能暂时这么做，但是需要提醒使用者注意。或者怀疑队友水平没那么高，理解不了你的代码，某天来修改代码并且容易改错。或者是因为这段代码『特立独行』，不是按照常规方式，你自己在这里耍了小聪明，或者用了自己设计的一些技巧性的东西，怕别人看不懂。
3、涉及到业务逻辑的代码，比如某些字段需要加说明，之类的。
有些业务的东西，确实不是一两句代码就能扯清楚的，这种东西，加个注释就好了。
4、因为修复某个bug而加进去的代码。
改bug，特别是改别人的bug的时候，如果不是进行大规模的重构，而是往里面加小段代码打补丁的时候，最好加上注释，否则这段代码很奇怪，并且容易看不懂。记住最好留上你的名字，不然后人看这个代码都不知道该去骂谁，hiahiahia~。
网友评论