代码整洁之道--注释，格式

最新推荐文章于 2025-04-27 23:24:02 发布
最新推荐文章于 2025-04-27 23:24:02 发布
阅读量405 收藏
点赞数
CC 4.0 BY-SA版权
分类专栏： 代码整洁 文章标签： 代码整洁
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/sinat_20476061/article/details/47291343
本文深入探讨了编程中注释的重要性、代码布局建议、命名规范等核心内容，旨在帮助开发者提高代码质量和可读性。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1、注释会撒谎。
程序员不能坚持维护注释
2、只需创建描述与注释相同的函数名即可
3、好的注释：对意图的注释；TODO注释
4、一个文件100行内
5、调用者应该放在被调用者上面
6、赋值周围加上空格
7、参数列表用空格隔开
8、加减号用空格隔开

《代码整洁之道》第四章 注释
zhangxiaoxiao9527的博客
06-14 1387
第四章 注释概述1. 好的注释1.1 法律信息1.2 提供信息的注释1.3 对意图的解释1.4 阐释1.5 警示1.6 TODO 注释1.7 放大1.8 公共API中的Javadoc2. 坏的注释2.1 喃喃自语2.2 多余的注释2.3 误导性注释2.4 循规式注释2.5 日志式注释2.6 废话注释2.7 位置标记2.8 归属与书名2.9 注释掉的代码2.10 非本地信息2.11 信息过多2.12 不明显的联系2.13 函数头2.14 非公共代码的Javadoc 概述 什么也比不上放置良好的注释来得有用。
代码整洁之道-----读书笔记
09-15
《代码整洁之道》是软件开发领域的一本经典之作，作者是Robert C. Martin（简称Uncle Bob）。这本书主要探讨了如何通过编写整洁、易于理解的代码来提高软件的质量和可维护性，尤其针对Java编程语言提供了许多实用的...
（读书笔记）代码整洁之道-注释
weixin_30951389的博客
09-08 486
代码整洁之道 注释 别给糟糕的代码加注释，重新写吧。 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。 1.注释不能美化糟糕的代码。 就是说，感觉需要写注释时先尝试优化代码。 2.用代码来阐述。 尽全力把代码写的简洁明了，再用注释解释。 3.好注释 1).法律信息(版权等等) 2).提供信息的注释 3).对...
代码整洁之道----注释篇
Just Do It!
08-17 607
1、代码描述你的意图，比如if判断条件比较复杂，比较长，很难理解，此时需要抽出一个函数说明条件更加清晰，比如   2、string是否为空的写法 if (name != null && ！name.equals("")) {      //do something } 或者 if (!"".equals(name)) {//将""写在前头，这样，不管name是否为null
代码整洁之道 注释
gtfaww的博客
12-28 416
注释 不要给糟糕的代码写注释，重新写吧。好的代码根本不需要注释。注释总是一种失败，因为我们无法找到不用注释就能表达自我的方法。注释会撒谎，程序员往往不能坚持维护注释。不准确的注释要比没有注释更糟糕。尽管有时候需要注释，但是我们应该多花心思减少注释。每个函数、变量都要有Javadoc是愚蠢可笑的。不要有注释掉的代码，直接删掉。去掉注释中的HTML标记。 好注释 唯一好的注释
代码整洁之道——注释
m0_37544464的博客
07-23 203
注释： 1. 如果想在右括号的后面增加注释，那么你要做的是缩短代码（昨天刚经历过） 2. 位置标记不要滥用，否则就会陷入背景噪声之中。 ////////function/////////////////// //去掉多余无用的斜杠 3. 源代码控制系统是代码归属与名命的最好归属地。比如Git。 4. 能用函数或是变量表示意思就不要用注释，用变量更好的表示自己的意思。 if(smodule.getDependSubsystems().contains(subSysMod.getSubSyste
代码整洁之道笔记-博客有
10-13
在注释的使用方面，第四章指出注释应当用来弥补代码无法清晰表达的意图，而不是替代清晰的代码表达。第六章讨论了对象与数据结构，提到得墨忒定律，即模块不应该了解它操作对象的内部情况，并强调隐藏结构的重要性，...
代码整洁之道读书分享.zip
09-03
《代码整洁之道》是软件开发领域的一本经典之作，由著名程序员Robert C. Martin（Uncle Bob）撰写。这本书强调了代码质量的重要性，尤其是整洁、可读和易于维护的代码对于项目成功的关键作用。在“逐步改进”和...
代码坏味道与启发--《代码整洁之道》总结.pdf
04-18
综上所述，《代码整洁之道》中的“代码坏味道”涵盖了从注释、环境设置、函数设计、代码组织到测试和Java特定问题的广泛领域，每一项都提供了深入的洞察和实用的建议，旨在帮助开发者编写出更高质量、更易于维护的...
代码整洁之道—注释
weixin_34198797的博客
01-31 153
别给糟糕的代码加注释——重新写吧 若编程语言有足够的表达力，就不那么需要注释——也许根本不需要。 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败，注意，失败。注释总是一种失败，我们总找不到不用注释就能表达自我的方法，总要有注释，这并不值得庆贺。每次写注释，你都该做个鬼脸，感受自己在表达能力的失败。 ...
代码整洁之道--注释
优秀的程序员不应该是CRUD
01-16 444
注释在代码中的地位举足轻重，但你有想过如何去写好注释吗？ 1、注释是为了美化糟糕的代码 我们为什么要写注释，一般如果一段代码需要写注释才能看的懂，那这是一个非常危险的讯号，我们的代码，应该在写的时候，就做道不用写注释，读代码，就能清楚的知晓代码所要做到事情，让代码自己去解释吧； 2、好注释 2.1 提供信息的注释 2.2 解释代码意图的注释 2.3对代码的阐述 2.4 警示性的注释 2.5 TODO注释 3、坏注释 3.1 自言自语的注释 3.2 毫无意义的
代码整洁之道----注释
c_lanxiaofang的博客
02-06 872
1、别给糟糕的代码加注释----重新写吧 2、注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。注释总是一种失败。我们总无法找到不要注释就能表达自我的方法，所以总要有注释，这并不值得庆贺。 3、如果你发下自己需要写注释，再想想看是否有办法翻盘，用代码来表达。每次用代码表达，你都该夸奖一下自己。每次写注释，你都该做个鬼脸，感受自己在表达能力上的失败。 4、注释会撒谎，也不是说总是如此或有意
Clean Code(代码整洁之道)-注释
ldc9001的专栏
01-23 440
注释的恰当用法是弥补我们在用代码表达意图是遭遇的失败。注释并不“纯然的好”，若代码有足够的表达力，则根本不需要注释。 1.注释不能美化代码：与其花时间编写解释糟糕代码的注释，不如花时间整理糟糕的代码。 2.用代码阐述：写注释前思考一下可否用函数来替代该注释，函数名称可体现相同的意义。 3.好注释：有些注释是必须的，也是有力的。   3.1).法律信息：公司代码规范要求编写与法律有关的注释，...
代码整洁之道【3】--注释
LifeIsGood
09-30 361
文章目录一、注释不能美化糟糕的代码二、用代码来阐述三、好注释四、坏注释 传统的印象里，良好的代码都是需要丰富的注释的。看完《代码整洁之道》注释这章之后，发现根本不是这个样子： 什么也比不上放置良好的注释有用。什么也不会比乱七八糟的注释更有本事搞乱一个模块。 什么也不会比陈旧的、提供错误信息的注释更有破坏性。 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。注释总是一种失败，我们无法找到不用注释就能表达自我的方法，所以不得不用注释，这并不值得庆贺。 注释存在的时间越久，就离其所描述的代码越远，越来越变得
【代码整洁之道】第四章：注释
水月洞天
10-17 247
第四章　注释 4.1注释不能美化糟糕的代码 与其花时间编写注释，不如清洁代码。 4.2用代码来阐述 用代码阐述大部分意图，少写些注释。 4.3好注释 4.3.1法律信息 不要将版权等信息全篇放进注释，可以指向许可证或文档。 4.3.2提供信息的注释 注释可以用来提供基本信息。 4.3.3...
《代码整洁之道 》第四章 注释
weixin_39924752的博客
11-12 428
什么也比不上放置良好的注释来得有用。什么也不会比乱七八糟的注释更有本事搞乱一 个模块。什么也不会比陈旧、提供错误信息的注释更有破坏性。注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。注意，我用了“失败”一 词。我是说真的。注释总是一种失败。我们总无法找到不用注释就能表达自我的方法，所以总要有注释，这并不值得庆贺。如果需要注释，就要想办法，能不能不要注释，使用代码去表达。注释出现太频繁，出现的时间越久，就离所描述的代码越远，因为代码一直在变动，而注释不一定跟着变动。只有代码能忠诚的告诉我们，他做了什么事
《代码整洁之道》第4章 注释 - 笔记
最新发布
CoFFee________的博客
04-27 448
注释的恰当用法是弥补代码表达意图时遭遇的失败，良好的代码，让读者看代码就能明白含义。代码在变动，在演化。注释并不总是随之变动。不准确的注释比没有注释要坏的多。注释算的上是一种没办法去除的恶。
《代码整洁之道》阅读笔记 4注释
weixin_41563161的博客
04-27 479
"Comments Do Not Make Up for Bad Code."（注释不是对劣质代码的补救）。事实上好的代码即便没有注释也拥有良好的可读性，但恰当的注释会让代码变得更可读、可维护性更高。 1.注释不能美化糟糕的代码 1.带有少量注释的整洁而有表达力的代码，要比带有大量注释的零碎而复杂的代码像样得多 2.与其花时间编写解释你搞出的糟糕的代码的注释，不如花时间清洁那堆糟糕的代码 2.用代码来阐述 用代码解释你大部分的意图，很多时候，简单到只需要创建一个描述与注释所言同一事物的函数即可 // ch
代码整洁之道：核心知识点幻灯片笔记
- 虽然好的代码本质上应该自我注释，但《代码整洁之道》也承认，注释在某些情况下是必要的。 - 作者提倡编写意图明确、简洁的注释，并且避免写出那些无用的注释，例如那些陈述显而易见事实的注释。 - 对于那些...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值