不写注释的代码相当于没有叉子的泡面

于 2023-10-09 17:46:19 发布
阅读量50 收藏
点赞数
文章标签： 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_61603704/article/details/133710482
版权

铁打的公司，流水的程序员，如果你不想给后面接替你工作的同事留下一堆屎山代码，一定一定一定要写注释！！！

针对页面的结构，可以按上中下，左中右，或者具体的名称添加注释

对于方法的注释，我通常习惯以 1 开头命名初始化操作，以及控制显示内容等方法，2 开头命名一级操作，例如打开编辑弹窗，查询操作等，3 开头命名进一步操作

最冷一天.
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
8.3-写代码必须要写注释吗？（为什么现实中不写注释？）
Robert Zhang
07-19 4225
一、写代码要写注释 “写代码要写注释”自从学编程，这就话就伴随着你。可见注释的重要性。 注释的作用： 说明函数的功能 说明函数参数的意思 说明函数这样设计的原理（计算公式） 说明函数的使用场景 作者和日期 说明变量的作用 函数调用方法与注意事项 总之为了能让读这个函数的人明白这个函数的功能，可以注释各种各样的信息。而没有这些注释文字，就不太容易看懂函数的功能与调用用方法。没有注释的情况下，隔一段时间之后，自己也看懂的自己所写函数的功能了。因此，很多书籍、老师、领导、同事、包括你自己，都会告诉你“一定要写
代码中到底应不应当写注释？
10-25
注释不应该是多余的废话，而是应该提供额外的、有价值的上下文信息。例如，对于复杂算法的实现、特殊处理的逻辑或一些重要的设计决策，提供注释是必要的。 此外，代码重构和注释的关系。注释本身并不是代码质量的...
我的代码很好，不需要写注释
嵌入式Linux
10-06 443
作者 | Sheetal译者 | 弯月 责编 | 王晓曼有时候，我们会写一些非常有创意的注释，而有些注释确实让人不得不佩服 程序员的想象力。看到下面这些注释，相信每个人都会捧腹大笑。【...
接手新项目，遇到没有注释的代码，简直就是炼狱
专注分享PHP、python、AI、web前端等知识
04-19 743
因为我对原来项目的框架不熟悉，开发起来比较费劲，就没有在那个基础上开发，而另外找了一个框架开发。但即使是这样，我也是遇到了很多问题，比如不知道这个方法是干嘛的，那个类是干嘛的，还有些不知道从哪里冒出来的文件被调用，弄得你昏头转向，不知所云。沟通起来就比较费劲了，有时候我们这边挺急的，但他们总是慢悠悠回答，在群里呼叫了几次才冒个泡，没办法，只能等了。就像我们公司，同一个群里的同事都在不同的地方上班，这样的缺点就是沟通成本太高，一个问题反复确认，对方有时候还不一定能真正理解你说的意思。欢迎留言谈谈你的看法。
如何写出没有注释的代码？
最新发布
IT界那些事儿
06-29 180
复杂的注释说明可能本身代码的逻辑是可能有问题的，整理逻辑图并重新梳理状态机的模型，可能比写出复杂的注释更有意义。注释很难得到维护，一个任务开发结束后，分布在任务中的注释大概率就不会再被更新，随着时间的推移，代码越来越复杂，可能注释的信息早已不能准确反馈当前的逻辑了。虽然无注释的代码也许终不可得，但是通过减少注释，审视我们的代码结构，让代码晚一日成为上帝的小秘密，那也是非常值得的啦。看似有了注释，再也不担心变成上帝的小秘密了。相信你的同学的能力，常见的操作，即使没有注释，也能够通过上下文理解出你的意图的。
代码自解释不是不写注释的理由
cpongo011702
04-05 540
有什么比花时间写注释更令人感到兴奋的事情吗？如果我没有猜错，你可能会说：“不好意思，所有事情都比写注释更令人感到兴奋”。如果有人要你给代码加上注释，对你来说就像是一种侮辱。你的代码写得如此优雅，它已经足以说明它要做的事情，注释是多余的，代码就是一切。无论是开源项目还是专业软件开发，代码注释通常有两种形式：要么没有和要么毫无用处。任何领域或使用任何编程语言的程序员，无论他们来自世界的哪个地方，似乎都...
什么时候应该避免写代码注释？
08-03
因此，"真理只存在于代码中"，强调代码的结构和逻辑应当直观到无需注释就能被理解。 避免写注释的一个准则是在你发现自己需要用注释来解释代码功能时，这可能是代码需要重构的信号。例如，通过提取方法重构...
手写数字识别OCR数据集以及识别代码附有详细注释
10-20
代码注释是初学者入门的重要资源，它们可以帮助理解每一步的目的和作用。比如，代码可能会解释如何加载数据集、定义模型结构、设置超参数、编译模型、进行训练以及评估模型性能。每个函数、变量和操作都有详细的注释...
程序员佛祖代码注释.txt
09-14
程序员佛祖代码注释，佛祖保佑，代码无BUG
Dreamweaver怎么给代码添加注释?
09-22
例如，你可以写“这是一个示例注释，用于解释这段代码的作用”。 7. 输入完注释后，按回车键，Dreamweaver会自动为你添加注释结束的符号“-->”，这样就完成了一个完整的HTML注释的插入。 对于CSS和JavaScript代码...
优秀的程序员真的不写注释吗？
热门推荐
沉默王二
05-11 4万+
我在很多地方看到这样一个观点，“请停止写注释，因为只有烂的代码才需要注释。”这个观点非常巧妙，它让我想起了孟子的一句话，“杨氏为我，是无君也；墨氏兼爱，是无父也。无父无君，是禽兽也。” 动不动就骂别人是“禽兽”，我总觉得有点不妥，这很不符合孟子的浩然之气啊。有些大牛也有孟子这样的觉悟，如果有人要他给自己的代码加上注释，就好像是对他的一种侮辱：“我的代码写得这么优雅，你难道看不懂吗？注释是多余的！” 我必须得承认，每个程序员都应该有一颗追求“优雅”的心，力争自己的代码更易阅读和理解——不只是针对机器，还有我
代码要写注释吗？写你就输了
shenjie12345678的专栏
05-25 2629
本文同步发表于我的微信公众号，扫一扫文章底部的二维码或在微信搜索 HelloWorld杰少 即可关注。 如何看待程序员不写注释？ “几个月前，我写的代码只有我和上帝知道” “现在，只有上帝知道了” 最近在知乎上看到了这个话题：怎样看待程序员不写注释？ 看了下浏览量居然有 30+w 次，看来大家讨论的挺热闹，我浏览了大部分的回答，发现大家的观点可以归纳为以下几点： 不写注释就是害人害己，别人看不懂，过几天连自己也看不懂 好的代码就是最好的注释，我的代码可读性很好，没必要写注释 只要有完善的文档，代码.
写程序不愿意写注释的问题
ckc的专栏
02-03 2831
注释的目的在于提高代码的后期维护性，也就是说花费了当前的工作时间换取以后节约更多的时间。 一次性代码、以后不需要维护的代码实际上不需要写注释。 结构清晰简单、很容易维护的代码可以少写甚至不写注释，写多了注释反而会降低工作效率。 代码越复杂越不容易维护，维护的人越是参差不齐，越是需要认真写注释。 判断注释、文档写的够不够其实很容易验证。如果代码将来也还是自己维护，那就找找几年前自己的代码，看
程序员为什么不写注释
代码菌的blog
03-24 9740
记得刚参加工作，经理就给组里的人发了一份他写的项目代码，当时面对这样一个大项目，看了几天，组里的人都抱怨代码没有注释，难读。这是经理就说了句话，我记到了现在： “你们老是抱怨别人的代码没有注释，可是你们有给自己的代码写注释吗？” 的确如此，我们希望看到别人的注释，同时又不想给自己的代码写注释。对于那些开源大型项目，一般会有良好的注释，团队本身也非常优秀，管理规范，项目拥有大量的用户，这
编写代码时，注释写还是不写
csdnyinchuan的专栏
11-24 2458
作者 & 编辑：按键学院   【按键精灵】 小编听过一句很有意思的话： “程序员最讨厌的四件事：写注释、写文档、别人不写注释、别人不写文档” 豆瓣上有被折腾的大神吐槽： “憎恨不写注释的人！！下班前准备好麻袋，还要一个榔头，血洗……” 也有同学们反驳： “好的代码本身就是最好的注释，写一堆注释本身就说明代码有问题。” 其实众说纷纭，各有道理。每件事都有它的正反两面，优胜劣势。 在此
提升代码规范：Java注释模板设置详解
本《编码规范代码注释模板设置说明手册》是一份实用的指南，旨在提升编程过程中的代码可读性和一致性。版本为v1.0.0，发布于2020年1月，适用于Java和JavaScript等语言。手册的核心内容是指导开发者如何在IntelliJ ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值