美文网首页
Clean Code 阅读笔记三

Clean Code 阅读笔记三

作者: 超级大鸡腿 | 来源:发表于2018-11-13 17:01 被阅读0次
Clean Code 阅读笔记三

注释不能美化糟糕的代码 带有少量注释的整洁而有表达力的代码,要比带着大量零碎注释而复杂的代码好得多 

      换做是我,也会毫不犹豫选择第二种方式,能够用代码阐述地尽可能避免          多 余的注释。当然也并不是说,没有注释更好,有些注释是必不可少的,          是有利的,如涉及到法律信息的,需要在源文件头部都加上相关信息的注          释。注释可以为我们的返回值增加说明,但是同样的我们尽可能可以使用          表达力强的函数名,也可以解决,这个时候显得注释就是多余的了。

坏注释 多余的注释徒增阅读者的压力,本身简单的函数或者变量名等,就不需要过多的注释去说明。一个函数的注释,很有可能随着时间的迁移,在下一位改动函数内部的人,很有可能就会因为其增加减少的代码而改变了注释的初衷,这时候注释带有很强的误导性了。用好注释,很多时候,需要开发人员及时的维护,这样才能保证注释的准确性以及它存在的价值。

小总结

其实我最大的感触是:尽可能选取表达力好的名字,名力能表其义,减少不必要的注释,让代码的表达力提高减少注释带来的风险。

相关文章

  • Clean Code 阅读笔记三

    注释不能美化糟糕的代码带有少量注释的整洁而有表达力的代码,要比带着大量零碎注释而复杂的代码好得多 换做是我,...

  • clean code笔记三

    9、系统 软件系统 一个系统就像一个城市,该如何管理呢。 城市能运转,还因为它演化出来恰当的抽象等级和模块,好让个...

  • Clean Code 阅读笔记二

    函数 在编程中,函数是编码中必见产物之一,如此常见,自然在编写的过程中,保持优雅。 函数尽可能的短小,越短小,越意...

  • Clean Code 阅读笔记五

    边界 日常开发中,为了快速开发出满足特定需求的接口,通常都会选择使用第三方框架,而这些第三方框架可以认为是不可控制...

  • Clean Code 阅读笔记六

    单元测试 对待单元测试的代码也应该像对待生产环境代码一样,都是代码,没有什么道理不优雅的对待,让测试不随着时间的流...

  • Clean Code 阅读笔记一

    前言 TPM之5S哲学 整理搞清事物所在-通过恰当的命名之类的手段--至关重要。 整顿物皆有其位,而后物尽归其位,...

  • Clean Code 阅读笔记四

    格式 日常编码中,需要保持良好的编码格式,自己选择简单好用规则,一致保持下去。团队合作中,成员们应该经过商量探讨从...

  • 代码整洁之道

    《Clean Code》代码整洁之道 一书相关读书笔记,整洁的代码是自解释的,阅读代码应该如同阅读一篇优秀的文章,...

  • Clean Code

    应公司周周享,重新去分享一次的Clean Code。结合以前的材料,自己重新阅读一边经典左右《Clean Code...

  • Reading Notes for《Clean Code》

    Chapter 1: Clean Code The Art of Clean Code? Let’s say yo...

网友评论

      本文标题:Clean Code 阅读笔记三

      本文链接:https://www.haomeiwen.com/subject/qxmlfqtx.html