程序员与代码注释的爱恨情仇

程序员对代码注释可以说是又爱又恨又双标……你是怎么看待程序员不写注释这一事件的呢?
1、对于程序员写代码注释这件事,我觉得代码注释的编写有必要,因为注释的编写有助于后续代码的维护和更新迭代,也有助于简化后来者对代码的阅读难度。但是,写代码与写注释在编程过程中是有点冲突的,因为在写代码的过程中想的是代码实现思路,如果思路正确,写代码如长江河水一发不可收拾地写,此时若你要我加注释上去进行解释说明,无疑是断人思路,扼杀灵感,这对程序员来说很致命。因为一但思路断了,代码可能就变成一堆烂泥,浪费了之前的时间与精力,得重头再来。没有程序员会为了一些后面才能用到的注释而放弃自己思索已久的思路与灵感,这是大多数人的直接想法。
2、在这里,又有人会说了,“如果不及时写上注释,后面的代码调试与维护,自己也看不懂咋办?”正所谓,一天模糊,两天失忆,三天不看即是陌生人。这是程序员对代码的短暂记忆的玩笑说法,其实程序员在看自己的代码时,主要注重的还是思路,思路在即程序正常运行。说三天就忘记代码,其实只是脑子在几天不见的情况下的一个短暂失忆,就如大家在日常生活中遇到的很多事情都会很忘记,记住的往往是印象比较很深刻的事情。
3、 言归正传,我对注释的编写与否是次肯定态度的,因为即使自己在写代码的过程中不写注释,但在看代码整理自己思路的时候也会补上关键注释,以防后期维护的查看与调整。此时又有人问了,“什么是关键注释?”在我看来,关键注释就是对自己所写的关键方法或者功能进行标注和小解。而不是以前老师常说的一行代码一行注释,那样子写完一个代码可能你已经累成狗了,即使后面你很容易就看懂你的代码,你也不会看那么多,只有关键代码才是主要的看点。就比如你写了登录功能的代码,你注释登录功能所采用的方法和关键字就行了,无需注释什么用户名、密码和验证码一一比对这些,你后面看到关键方法就能看懂具体的实现过程了。
4、 以上就是我对代码注释编写与否的看法,可能写的不够全面,但有些企业内部的问题自己去体会才行,希望我的看法对各位有所帮助!

你可能感兴趣的:(代码规范,源代码管理,java)