因一段奇怪代码,程序员被同事深夜电话叫醒,原因竟在代码注释!
作为互联网的从业人员,好多程序员都知道,手机要保持随时开机的状态,因为自己写的代码是在线上24小时不间断运行,一旦出现什么重大故障,保证能随时知道并立即解决,虽然有的公司没有明确规定,但是有经验的程序员都有这方面的意识,时刻保持开机状态,以防有重要的线上问题联系不到自己,当然这样的程序员是非常敬业的,是值得尊敬的,近期就有这样一个案例,一名程序员小哥被深夜叫醒!
这是一名新浪的程序员小哥,他半夜被一个投诉电话叫醒了,查了半天代码发现问题的原因是一个莫名其妙的if代码块,他看了半天都没看明白这段逻辑,感觉好似奇怪,在这迫不得已的情况下,他也只能在深夜打电话去询问提交这段代码的那个同事了,经过沟通后才发现这样的一个奇怪逻辑是以前产品提出的一个特殊需求,这才算是对整个事情了解了,如果代码的此处有一段注释就可能没必要这番折腾了,通过此事让这名程序员直呼代码注释的重要性,针对这样一个情况,让我们一起看看网友们都是怎么认为的吧!
网友一:程序员最讨厌的事:别人不写文档,别人不写注释;自己写文档,自己写注释!
作者点评:这名网友又把这个梗给搬出来了,看见了吧,就因为程序员不爱写注释,结果深夜被电话叫醒了!
网友二:我会写注释,而且会把理论依据(产品的要求)写出来。就是为了以后可以暴打产品
作者点评:别这么暴力,只能说把注释写出来是为了别人能看懂,知道这么做的前提背景条件!
网友三:呵呵,程序员如果明显逻辑不检查,测试干嘛去了,详细开发文档的人干嘛去了,这锅产品不背。除非反馈了产品要硬上。
作者点评:有道理,总之这个环节还是有点疏漏了,产品提出需求,程序员实施开发,测试人员对新增功能进行验证,既然上线了,说明这个功能大家都是认可的,认为没问题的,如果真有问题,说明这个流程中那个环节做的并不是十分的到位,需要反思!
网友四:深夜打给同事,有那么着急吗
作者点评:他也是深夜接到投诉,对代码的奇怪逻辑看不懂,也是迫不得已吧!
网友五:我一般都不写,别人要求加的 我觉得不合理的 就加了注释
作者点评:最好是养成写注释的习惯,特别是那些让人易产生误解的代码,更应该加注释了。
网友七:运行太快了,产品要求sleep几秒
作者点评:接下来你是想说,如果用户想增加产品流畅度,加了钱,你会把sleep的秒数变短一点,然后告诉用户你对程序进行了一次效率上的优化吗?
网友八:难道你们在代码注释里把产品需求写上?
作者点评:不是说把产品需求搬进去,就是简单的一句话,能让人了解这么写的原因,不至于产生误解!
有时写一些代码注释,看似是浪费了时间,其实是节省了代码的维护时间!当被别人不断问这段代码的意思时,甚至半夜被电话叫醒时,就能深刻体会这句话是非常有道理的了,另外,通过这个事例,我们也看到在开发流程环节的一些问题,第一产品的需求没有在产品文档中形成,只是通过口头把需求说给了程序员,程序员对投诉的情况只能是通过看代码,而不是看文档,第二,程序员的代码没有写注释,这也导致了其他程序员看不懂这段逻辑,还要给提交代码的人打电话,第三,测试人员也没有认真对这个新增的需求进行测试验证,害的上线之后用户反馈投诉才造成了这一系列现象,因此通过这个案例,我们要好好反思一下自己平时的开发流程是否完善,是不是有改进的地方,只有完善的开发流程,才能让工作更顺心,更惬意,不是吗?
以上所有图片均来之互联网
大家好,我是“上世是朵花”。如果你有什么好的看法或者观点可以在评论区展现你的才华,互动交流,如果想进一步了解我,那就关注我吧!