怎么看待程序员不写注释
咱们好,我是Leo,今日咱们来聊一下关于代码注释的问题话不多说,让咱们开端吧。
在开端阅览正文之前,你先想 3 个问题:
- 你平时写代码的时分会写注释嘛?
- 你的注释是怎么样写的,主要都表达些什么?
- 你一般会在什么样的代码里写注释?
好了,正文开端。
1.我对注释的看法
首要,我个人刚开端写代码的时分,十分喜欢写注释,我一般会把代码思路先用文字表述出来。然后分红 1 2 3 4 每一步要干什么,怎么干。
然后写完之后开端在每个步骤下边填代码,这个时期我的代码注释量是十分高的。
可是后来随着技能熟练程度的进步,以及代码水平的进步,我的注释量就逐步减少了。
并不是我觉得自己牛逼了不用写代码了,也不是我想专门给后人挖坑,纯粹是我觉得不太有必要了。
由于一方面我认为当你能够写出相对比较好的代码的时分,你的代码就是你的注释,你的命名、你的日志以及你的单元测试等等一切东西会一起构建成你的完好注释,终究他们合在一起构成的注释远比你一字一句写出来的注释要更清楚更实用。
并不是只要 // 后写的才叫注释。
2.不写程序的结果(狗头)
咱们来简略聊一聊之前的一个国外新闻。
咱们或许平时开开玩笑说,你不写注释或许被搭档杀了,咱们都当成一个笑话来听,可是其时美国程序员不写注释是真的在现实生活中演出。
以下内容来自网络。
据云头条报道,周三上午10点20左右,43岁的安东尼汤(Anthony Tong)出现在办公室,拿出一把事前藏起来的半自动手枪开火。他在威斯康星州米德尔顿的这家公司作业了一年多。
作业人员纷纷逃离办公楼,跑到附近的公司流亡。
行凶者随后向短短几分钟内赶到WTS Paradigm现场的警察开枪。四名警察随后开火,击中了嫌犯。嫌犯一送到医院就被宣布死亡。
WTS Paradigm的事务分析员朱迪拉默斯(Judy Lahmers)说,其时自己正伏案作业,忽然听到“像是有人把木板扔在地上,声音很响很响”。她赶忙跑出大楼,躲在一辆轿车后边。她告知美联社:“我头也不回地拼命跑。你只想知道‘该躲起来仍是跑远?”
她不知道关于枪击案的任何其他信息,但表明“完全出人意料。咱们都是搞软件的。咱们是很好的团队。”
警方介绍,这名死者自上一年4月以来一直在WTS作业,没有违法记录,枪击事件产生时独自作案。目前,没有任何迹象表明到底是什么原因引起这起流血事件。
从这这个新闻,来说说我的看法:
1、代码不标准,的确看着蛋疼,尤其命名看不懂时,接手过去的代码,要去猜测对方代码,或许只要事人才看得懂。所以一定要标准,在大公司写的不标准,别人会直接怼你的。搞不好就是对你能力置疑。
2、代码这个事情,有些人有洁癖,容不得废物代码在项目中,那么什么代码是废物代码,如命名不标准,成员变量没有表明其意义,函数名字不能充分表明其功能,大量if else逻辑,一个办法几百上千行代码,这些都是不良的习气。
3、git提交时,老是覆盖提交,没有解决冲突,还有一次性改100多个类文件,1周才提交,有些兼容特别处理当地不写注释,只要上帝才看懂。
4、凶手几名搭档,肯定没有看过《重构,改进既有代码的规划》这本书,引荐咱们好好读一读。避免类似悲剧产生
当然,还有一种情况我是建议写注释的,那就是二笔产品非要提一个不合理的需求导致你有一个不合理的写法,这个时分我希望你能注明“不是我要这么写的,是产品需求要求这样的,我也没办法的”的无法,免得下一任接受你代码的人骂娘,说你是个菜鸡。
好了,今日的内容就到这里了。
3.总结
以上就是本文的全部内容,本人才疏学浅,文章有什么错误的当地,欢迎大佬们批评指正!我是Leo
,一个在互联网职业的小白,立志成为更好的自己。
如果你想了解更多关于Leo
,能够重视下面这个大众号,后边文章会首要同步至大众号。
4.参阅文章
- www.sohu.com/a/255608448…