java码农:我写代码会加注释但不会写作者名,这其中是有原因的!
对于编程来说,特别是一些业务开发,写代码与写注释是一样重要的,如果时间紧可以暂时不写文档或者后补,但是代码注释是必须要有的,代码的注释对代码的维护起着至关重要的作用,即便如此好多程序员在写代码注释上还是过于敷衍或者说潦草,都认为是自己写的代码,有什么看不懂的,虽是这么想的,但是时间久了,再回来看自己的代码,还真有点费劲,我想部分程序员是有这种体会的吧,既然自己就是这样,那对于其他人来说,来看自己的代码就更困难了,因此写代码不写注释不是一种好习惯,关于写注释的事,有一名程序员网友给我们分享了他的一个特点。
据这名程序员网友说,他写代码,从来不留@author注解,但是普通注释他还是会加的,之所以这么做,他卖萌似的说了一句,如果代码有问题,要想揪出我,只能通过Git日志,不给他们提供那么便利的条件,呵呵,这么说看来对自己写的代码还是不够自信了啊,为什么总是想着会有问题呢,与他相反,我之前遇到的一位程序员是注释不注释的不在乎,只要写代码先把作者名称给挂上,甚至有的时候从网上复制别人的代码,他也会把作者名称改成自己的,他的理由是这是工作量证明啊,自己写的东西肯定要标记自己的名字呀,看来他们看问题的角度还是真的挺不一样,针对这些情况,让我们一起看看其他网友们都是怎么看待的吧!
网友一:这是一个好习惯
上世是朵花:看来这名网友平时也是同样的想法或者是采取相同的做法喽。
网友二:Author没啥用。只是个初始版本
上世是朵花:没错,Author只是初建者人的名字,中间还有可能经过多人修改这段代码。
网友三:jetbrains全家桶右键显示注解,谁的锅一目了然
上世是朵花:工具只是辅助作用吧,其实最实质的,最精确可靠的是看提交日志了。
网友四:又不是写了author就都是这个人改的,被人改出问题太常见了
上世是朵花:是的,这名网友在这方面可见很有体会,有相当一部分情况是,你写的代码可能是其他人也在修改。
网友五:写这没用,代码可能被别人改,写了会背锅
上世是朵花:我想遇到严重的问题不可能只是看作者名称这么简单吧,也肯定会追得更细一点吧,有的程序员已经离职2年了,这之后再出什么问题肯定不关他的事了,虽然代码的作者还标的是他的名字。
网友六:归根结底,还是对自己代码质量没信心
上世是朵花:有点这个意思吧,算是不够自信的表现。
其实,关于注释的作者名称只是表明代码这段代码的初创人是谁,由谁发起的而已,在实际情况中,大家都知道,一些代码可能是由多个人来维护的,虽然作者的名字是不变的,如果这段代码出问题就去找标有作者名称的人,相信好多程序员是比较冤枉的,另外大家都知道,现在的IDE工具写注释非常方便,就以java代码为例,你通过IDE创建一个类,一些方法 类get,set方法以及注释,作者等信息在事先设置的规则下就自动生成了,注释的作者都是可以轻松编辑的,既然能轻松编辑,那么绝对不是通过这个东西进行定责的,这样的做法显然是不靠谱的,标记作者只是信息展示的一部分,不过我个人觉得还是标上自己的名称吧,起码能让人看出来这些代码是由你主导来写的,起码也能体现你的工作量不是么?如果写了很多代码,以后不在公司了,后来的程序员还能在代码中知道你的名字,这也不是挺好的吗?
以上所有图片均来之互联网
大家好,我是“上世是朵花”。如果你有什么好的看法或者观点可以在评论区展现你的才华,互动交流,如果想进一步了解我,那就关注我吧!