程序员写代码要写注释吗？写你就输了

最新推荐文章于 2024-06-18 01:27:08 发布
易哥说测试 最新推荐文章于 2024-06-18 01:27:08 发布
阅读量2.2k 收藏 5
点赞数
分类专栏： 学习 程序人生 文章标签： 单元测试 c++ c#
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接： https://blog.csdn.net/m0_60719784/article/details/119957622
版权
本文探讨了程序员是否应该写注释的话题，指出不写注释的危害，如代码难以理解和维护。强调了注释的重要性和良好的注释习惯，包括文件注释、类注释、函数注释和变量注释等，同时展示了各种类型的代码注释实例。文章提醒程序员，写好注释是提高代码可读性和团队协作效率的关键。
摘要由CSDN通过智能技术生成

前言：在职业发展道路上，需要不断提升自己，需要学习资源的，一起学习交流的欢迎加群【443128517】，小编准备了学习视频，学习线路，自学书籍，职业发展视频。也可以加美女老师七七的微信。二维码放在下面！

 

 如何看待程序员不写注释？

“几个月前，我写的代码只有我和上帝知道”

“现在，只有上帝知道了”

最近在知乎上看到了这个话题：怎样看待程序员不写注释？ 看了下浏览量居然有 30+w 次，看来大家讨论的挺热闹，我浏览了大部分的回答，发现大家的观点可以归纳为以下几点：

  1. 不写注释就是害人害己，别人看不懂，过几天连自己也看不懂
  2. 好的代码就是最好的注释，我的代码可读性很好，没必要写注释
  3. 只要有完善的文档，代码本身就是注释
  4. 自己写代码时：“我自己写的代码还要写注释？” 看别人的代码时：“卧槽这人居然不写注释？”

对于程序员群体，有位知乎网友的总结非常到位：程序员最讨厌的四件事：1. 写注释 2. 别人不写注释 3. 写文档 4. 别人不写文档，不得不说我们程序员群体真是个可爱而又敢于自黑的群体。

image

说实话，我第一次看到这个话题的时候，我愣了一下，心想谁会提出这么沙雕的问题，在我看来写代码不写注释，那不就跟耍流氓一样嚒！在我第一天开始写代码的时候，我的老师就告诉我注释的重要性，就好比渴了要喝水，饿了要吃饭一样，这是编码的习惯。

image

我们写代码不仅仅是只给编译器看，还要给自己身边的同事看，假如有一天休假，你把工作交接给了你的同事社会王，你正吃着火锅唱着歌呢，社会王因为帮你解决 Bug 而又看不懂你的代码，给你来个夺命连环 Call，你还有什么心思度假。有人也会说：“我自己写的代码只要我自己看的懂就行”，可事实上不写注释，时间一久，等需要重新拾起来的时候你就会发现：“卧槽，这是啥？这为啥报错”。所以给代码添加合格的注释不仅能够让别人更快速的接手你的代码，也能更快的让拾起自己的代码。

image

迷惑行为

在正式的给大家讲解如何写出合格的注释之前，先给大家看下各种脑洞大开的代码注释：

斗图型

image

image

最低0.47元/天 解锁文章
程序员的注释之道
Robbie Mosaic's T-Log
10-27 3711
SAP高级开发工程师 范德成 2014年10月25日   写这篇文章之前，我所思考的前一个问题是代码的质量。而在编写了好的代码的前提下，代码的注释就成了代码质量的另一部分——它的作用初看时显得并不那么大，但是越到后面越显得重要。当一名勤奋的程序员为了一个大项目，洋洋洒洒地写了数千行代码之后，他转而去做该项目的另一个模块。等到一年后，他回头再来看他之前写的这几千行代码时，如果没有详细有意义的注
基于stm32的智能蓝牙/wifi小车设计及部分代码（带注释未完待写）
m0_65003238的博客
10-24 733
智能小车是stm32中非常经典的项目，了解完32的库函数之后即可自己开发。
跟我一起写 Makefile-陈浩
陈腾奎KUI的博客
05-19 3912
 makefile：是告诉编译器（交叉工具链）如何去编译、链接一个工程的规则。 一、概述     什 么是makefile？或许很多Winodws的程序员都不知道这个东西，因为那些Windows的IDE都为你做了这个工作，但我觉得要作一个好的和 professional的程序员，makefile还是要懂。这就好像现在有这么多的HTML的编辑器，但如果你想成为一个专业人
代码自解释不是不写注释的理由
cpongo011702
04-05 564
有什么比花时间写注释更令人感到兴奋的事情吗？如果我没有猜错，你可能会说：“不好意思，所有事情都比写注释更令人感到兴奋”。如果有人要你给代码加上注释，对你来说就像是一种侮辱。你的代码写得如此优雅，它已经足以说明它要做的事情，注释是多余的，代码就是一切。无论是开源项目还是专业软件开发，代码注释通常有两种形式：要么没有和要么毫无用处。任何领域或使用任何编程语言的程序员，无论他们来自世界的哪个地方，似乎都...
优秀的程序员真的不写注释吗？
热门推荐
沉默王二
05-11 4万+
我在很多地方看到这样一个观点，“请停止写注释，因为只有烂的代码才需要注释。”这个观点非常巧妙，它让我想起了孟子的一句话，“杨氏为我，是无君也；墨氏兼爱，是无父也。无父无君，是禽兽也。” 动不动就骂别人是“禽兽”，我总觉得有点不妥，这很不符合孟子的浩然之气啊。有些大牛也有孟子这样的觉悟，如果有人要他给自己的代码加上注释，就好像是对他的一种侮辱：“我的代码写得这么优雅，你难道看不懂吗？注释是多余的！” 我必须得承认，每个程序员都应该有一颗追求“优雅”的心，力争自己的代码更易阅读和理解——不只是针对机器，还有我
代码要写注释吗？写你就输了
shenjie12345678的专栏
05-25 2742
本文同步发表于我的微信公众号，扫一扫文章底部的二维码或在微信搜索 HelloWorld杰少 即可关注。 如何看待程序员不写注释？ “几个月前，我写的代码只有我和上帝知道” “现在，只有上帝知道了” 最近在知乎上看到了这个话题：怎样看待程序员不写注释？ 看了下浏览量居然有 30+w 次，看来大家讨论的挺热闹，我浏览了大部分的回答，发现大家的观点可以归纳为以下几点： 不写注释就是害人害己，别人看不懂，过几天连自己也看不懂 好的代码就是最好的注释，我的代码可读性很好，没必要写注释 只要有完善的文档，代码.
写代码的时候一定要写注释吗？
最新发布
Twinkle_sone的博客
06-18 404
🎈程序员最讨厌两件事： 一是别人不写注释 二是要自己写注释。
什么样的代码最能代表程序员的暴力美学？
CXY_QIQI的博客
05-28 448
前言： 昨天和朋友在吃晚餐时候，聊了一会高并发的事情，后面越扯越远，扯到什么代码最能代表程序员的暴力美学，所以昨天吃完饭我就在上网上疯狂找这一块的资料，在结合自己所看到的，下定决心发这一篇文章，来刷新一下自己的感官！同时也分享给大家来欣赏程序员这个领域的暴力美学，分享以下十个小故事，如果不爱看可以跳过奥！ 一；莫名有三个字从心里奔腾而出 曾经看过 一个 网站的 源码 一个按钮 引起我的注意 叫 “清除浏览器缓存”。我当时想的 怎么清除的，清除哪些东西，我得去学学。 然后我看到了 <a on
C++代码书写规范——给新手程序员的一些建议
qq_43351159的博客
06-22 893
代码就是程序员的面子，无论是在工作中在电脑上写程序代码还是在面试时在纸上写演示代码我们都希望写出整洁，优雅的代码。特别在工作中当我们碰到需要维护别人的代码，或者是多人参与一个项目大家一起写代码的时候，如果碰到一些丑陋的代码，我们还要看懂并且修改它的时候，那种难受，肯定会让我们回想起多年以前自己还是新手程序员的时候，写下的那些丑陋的代码，并且深深内疚于将它们留给了我们的后继者，不知道他们和它们是否还安好。所以，强调代码的规范性，写出整洁，优雅，可读性高的代码应该是成为一个合格的程序员的第一步。这里我就抛砖引.
因代码不规范，程序员枪击4名同事，程序员要保命啊
java1856905的博客
03-29 933
曾经，程序君被一则发生在美国的枪击案件刷新了三观，究其原因，行凶者竟然是大众眼里平日里大门不出，二门不迈，埋头苦敲代码的程序员。 据悉，该名程序员来自美国威斯康星州米德尔顿，枪击案件发生前，他为威斯康星州米德尔顿的WTS Paradigm公司工作，并已经持续了一年。 本应该埋头编写代码，然后升职加薪，迎娶白富美，走上人生巅峰的他。 却因为同事不写注释，不遵循驼峰命名，括号换行，最严...
网上转的 程序员写代码基本要求
流云
07-19 1338
转帖]程序员写代码基本要求基本要求1.1 程序结构清析，简单易懂，单个函数的程序行数不得超过100行。1.2 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。1.3 尽量使用标准库函数和公共函数。1.4 不要随意定义全局变量，尽量使用局部变量。1.5 使用括号以避免二义性。2.可读性要求2.1 可读性第一，效率第二。2.2 保持注释与代码完全一致。2.3 每个源程序文件，都有文件头说明，
编写代码不能不写注释
Q
11-21 3953
有时候，一件小的事情，未必小。写代码不写注释就是这样的一件小事，但是这个现象显示的深层道理一点也不小。         写了这么多年了代码了，见过很多人还是规规矩矩的将代码写好，而且并写一个高质量的注释来让代码更加饱满；也见过很多人写起来代码行云流水，潇潇洒洒，但是一句注释也没有；所以我就经常看到这样的现象和听到这样的话语：          Xxx，搞毛线啊，连个注释都不写，他摇摇屁股走人了，把
代码注释的艺术，优秀代码真的不需要注释吗？
HollisChuang's Blog
06-24 362
前言Hollis的新书限时折扣中，一本深入讲解Java基础的干货笔记前天回家路上，有辆车强行插到前面的空位，司机大哥吐槽“加塞最可恶了”，我问“还有更可恶的吗”，司机大哥淡定说道“不让自己加塞的”。似乎和我们很类似，我们程序员届也有这2件相辅相成的事：最讨厌别人不写注释，更讨厌让自己写注释。一段糟糕的代码，往往大家最低的预期是把注释写清楚，最合理的做法通常应该对代码做优化...
Java 程序员如何写注释
我的专栏
02-06 976
1. 首先设置 ADT／Eclipse -> Perference -> Java -> Code Style -> Code Templates , 自定义自己想要的注释模版。 2. 也可以手动敲注释，一般Java 基本上只需要知道五个基本标识: /** * The extra key of intent. * Use this key to obtain th
程序员最讨厌的两件事:1.自己写注释2.别人不写注释
越是安静内敛的人，越容易生不惊人死不休
06-13 630
程序员最讨厌的两件事:1.自己写注释2.别人不写注释。
程序员专属注释
凌风的博客
06-27 1091
``` /**========================我 是 分 割 线================== // _ooOoo_ // o8888888o // 88&quot; . &quot;88 // ...
关于程序员不写代码注释这一件事
沐雨橙风ιε的博客
10-12 292
4、和代码编写不同的是，代码注释本身并没有统一的规范，所以，其实完全可以根据自己的喜好来写，甚至可以在service层的impl实现类的方法上面加上整个业务的核心步骤并编号，然后在代码中也复写一次，类似于书的目录。3、漂亮的注释要配合适当的代码缩进才能达到更好的效果，如果所有代码之前都没有空格和换行，那么你的代码整体会非常乱，哪怕写了注释也一样。博主个人写代码是肯定会写注释的，哪怕是简单的功能，文档注释、多行注释、单行注释怎么顺手怎么用，让一个小白也能看懂自己的代码。2、平时没有养成写代码注释的习惯。
编写代码时，注释写还是不写
csdnyinchuan的专栏
11-24 2469
作者 & 编辑：按键学院   【按键精灵】 小编听过一句很有意思的话： “程序员最讨厌的四件事：写注释、写文档、别人不写注释、别人不写文档” 豆瓣上有被折腾的大神吐槽： “憎恨不写注释的人！！下班前准备好麻袋，还要一个榔头，血洗……” 也有同学们反驳： “好的代码本身就是最好的注释，写一堆注释本身就说明代码有问题。” 其实众说纷纭，各有道理。每件事都有它的正反两面，优胜劣势。 在此
写代码不写注释，你是在耍流氓吗？
fasdfasfwerwqf的博客
11-02 240
作为一个程序员，你是否经常遇到这样的情况：当你看到别人写的代码时，你感觉像是在破译一个古老的密码，完全不知道它是做什么的，为什么要这样写，有什么特殊的考虑或注意事项；当你回顾自己写的代码时，你感觉像是在重温一个噩梦，完全不记得它是怎么运行的，为什么要这样设计，有什么优缺点或改进空间。注释是程序员之间沟通和交流的重要工具，是代码质量和效率的保证。综上所述，写注释是程序员的基本素养和职业责任，是编程的必要和重要的一部分。所以，请你在写代码时，不要忘记写注释，给自己和他人一个方便和快乐。那么，如何写好注释呢？
idea 阅读代码技巧
10-19
阅读代码是程序员日常工作中必不可少的一部分，以下是一些阅读代码的技巧： 1. 阅读代码前先了解需求和设计，这有助于理解代码的目的和结构。 2. 从主干逻辑开始阅读代码，逐步深入细节。 3. 注意代码中的注释和文档...
写文章

热门文章

  • Python爬虫超详细讲解（零基础入门，初中生都看的懂） 7281
  • 【干货满满】学习java开发，用什么样配置的电脑好？ 3410
  • 十款经典游戏的Java版本（附源码） 2923
  • 2021版最新大厂前端面试题库（内含详细答案），找工作的小伙伴快收藏起来 2682
  • 程序员写代码要写注释吗？写你就输了 2206

分类专栏

  • 软件测试 1篇
  • 自学路线 9篇
  • 程序人生 33篇
  • 课程教学 10篇
  • 学习 31篇
  • 面试 2篇

最新评论

  • Python爬虫超详细讲解（零基础入门，初中生都看的懂）

    她想不出网名了: 真的超级喜欢这种小白分享www

  • 【2021开发者调查报告出炉】JavaScript最流行，Vue.js跻身最常用Web框架前五，Stack Overflow

    des643: 请不要乱发，你这个前端框架 jquery都和后端 flask框架做对比，，你真的是厉害

  • 程序员写代码要写注释吗？写你就输了

    周子尘0472: 看来注释是极其有必要的，只是没必要处处注释而已

  • Python爬虫超详细讲解（零基础入门，初中生都看的懂）

    weixin_49785773: 七减一七减一七减一

  • 我用Python爬取了五千张美女图壁纸，每天一张忘记初恋！

    m0_59187827: 怎么指定文件夹

最新文章

  • 35岁的软件测试从业人员还有出路？听10年测试老鸟易哥怎么说！
  • 我是如何2个月快速掌握Python的！学习大纲+学习方式+学习资料 汇总！跟着我的路线就对了
  • 立马提升level！这几个Python进度条绝绝子！
2022年1篇
2021年39篇

目录

目录

评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值

玻璃钢生产厂家工艺玻璃钢人物雕塑规定安徽仿铜玻璃钢雕塑定制漯河玻璃钢雕塑公司做玻璃钢雕塑价格表河南水果玻璃钢雕塑哪家便宜福建雕塑玻璃钢商丘标牌标识玻璃钢彩绘雕塑江苏玻璃钢雕塑制作多少钱艺术玻璃钢雕塑有哪些镇江玻璃钢人物雕塑创意玻璃钢雕塑价格艺术玻璃钢造型雕塑玻璃钢雕塑要求贵州玻璃钢海豚雕塑定制焦作人物玻璃钢雕塑商场美陈 主题永州邵阳玻璃钢雕塑设计南京家用玻璃钢雕塑摆件胶州玻璃钢卡通雕塑邵阳公园玻璃钢雕塑定制株洲玻璃钢雕塑价格多少钱广东大型商场美陈研发中山玻璃钢动物雕塑厂家现货黄山抽象玻璃钢雕塑市场顺德玻璃钢花盆花器湖北公园玻璃钢雕塑公司汕尾公园玻璃钢雕塑玻璃钢雕塑油漆翻新施工工艺郑州标识玻璃钢彩绘雕塑生产合肥动物玻璃钢雕塑生产厂家香港通过《维护国家安全条例》两大学生合买彩票中奖一人不认账让美丽中国“从细节出发”19岁小伙救下5人后溺亡 多方发声单亲妈妈陷入热恋 14岁儿子报警汪小菲曝离婚始末遭遇山火的松茸之乡雅江山火三名扑火人员牺牲系谣言何赛飞追着代拍打萧美琴窜访捷克 外交部回应卫健委通报少年有偿捐血浆16次猝死手机成瘾是影响睡眠质量重要因素高校汽车撞人致3死16伤 司机系学生315晚会后胖东来又人满为患了小米汽车超级工厂正式揭幕中国拥有亿元资产的家庭达13.3万户周杰伦一审败诉网易男孩8年未见母亲被告知被遗忘许家印被限制高消费饲养员用铁锨驱打大熊猫被辞退男子被猫抓伤后确诊“猫抓病”特朗普无法缴纳4.54亿美元罚金倪萍分享减重40斤方法联合利华开始重组张家界的山上“长”满了韩国人？张立群任西安交通大学校长杨倩无缘巴黎奥运“重生之我在北大当嫡校长”黑马情侣提车了专访95后高颜值猪保姆考生莫言也上北大硕士复试名单了网友洛杉矶偶遇贾玲专家建议不必谈骨泥色变沉迷短剧的人就像掉进了杀猪盘奥巴马现身唐宁街 黑色着装引猜测七年后宇文玥被薅头发捞上岸事业单位女子向同事水杯投不明物质凯特王妃现身！外出购物视频曝光河南驻马店通报西平中学跳楼事件王树国卸任西安交大校长 师生送别恒大被罚41.75亿到底怎么缴男子被流浪猫绊倒 投喂者赔24万房客欠租失踪 房东直发愁西双版纳热带植物园回应蜉蝣大爆发钱人豪晒法院裁定实锤抄袭外国人感慨凌晨的中国很安全胖东来员工每周单休无小长假白宫：哈马斯三号人物被杀测试车高速逃费 小米：已补缴老人退休金被冒领16年 金额超20万

玻璃钢生产厂家 XML地图 TXT地图 虚拟主机 SEO 网站制作 网站优化