程序员写代码要写注释吗?写你就输了
前言:在职业发展道路上,需要不断提升自己,需要学习资源的,一起学习交流的欢迎加群【443128517】,小编准备了学习视频,学习线路,自学书籍,职业发展视频。也可以加美女老师七七的微信。二维码放在下面!
如何看待程序员不写注释?
“几个月前,我写的代码只有我和上帝知道”
“现在,只有上帝知道了”
最近在知乎上看到了这个话题:怎样看待程序员不写注释? 看了下浏览量居然有 30+w 次,看来大家讨论的挺热闹,我浏览了大部分的回答,发现大家的观点可以归纳为以下几点:
- 不写注释就是害人害己,别人看不懂,过几天连自己也看不懂
- 好的代码就是最好的注释,我的代码可读性很好,没必要写注释
- 只要有完善的文档,代码本身就是注释
- 自己写代码时:“我自己写的代码还要写注释?” 看别人的代码时:“卧槽这人居然不写注释?”
对于程序员群体,有位知乎网友的总结非常到位:程序员最讨厌的四件事:1. 写注释 2. 别人不写注释 3. 写文档 4. 别人不写文档,不得不说我们程序员群体真是个可爱而又敢于自黑的群体。
说实话,我第一次看到这个话题的时候,我愣了一下,心想谁会提出这么沙雕的问题,在我看来写代码不写注释,那不就跟耍流氓一样嚒!在我第一天开始写代码的时候,我的老师就告诉我注释的重要性,就好比渴了要喝水,饿了要吃饭一样,这是编码的习惯。
我们写代码不仅仅是只给编译器看,还要给自己身边的同事看,假如有一天休假,你把工作交接给了你的同事社会王,你正吃着火锅唱着歌呢,社会王因为帮你解决 Bug 而又看不懂你的代码,给你来个夺命连环 Call,你还有什么心思度假。有人也会说:“我自己写的代码只要我自己看的懂就行”,可事实上不写注释,时间一久,等需要重新拾起来的时候你就会发现:“卧槽,这是啥?这为啥报错”。所以给代码添加合格的注释不仅能够让别人更快速的接手你的代码,也能更快的让拾起自己的代码。
迷惑行为
在正式的给大家讲解如何写出合格的注释之前,先给大家看下各种脑洞大开的代码注释:
斗图型
她想不出网名了: 真的超级喜欢这种小白分享www
des643: 请不要乱发,你这个前端框架 jquery都和后端 flask框架做对比,,你真的是厉害
周子尘0472: 看来注释是极其有必要的,只是没必要处处注释而已
weixin_49785773: 七减一七减一七减一
m0_59187827: 怎么指定文件夹