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

Clean Code 阅读笔记一

作者: 超级大鸡腿 | 来源:发表于2018-11-13 16:58 被阅读0次
开启代码优雅的第一步

前言 TPM之5S哲学

整理 搞清事物所在-通过恰当的命名之类的手段--至关重要。

整顿 物皆有其位,而后物尽归其位,代码不应该出现在它不应该出现的地方。

清楚 清楚又可以说是清洁,对于无用的废弃的代码除之而后快。

清洁 也可以说是标准化,有着一贯的风格以及实践手段。

身美 亦可以说是自律,在实践中贯彻理论,体现在个人的工作之上。

读代码比写代码更为常见

日常开发过程中,在写新代码的过程中,只要是在原先基础上添加的,都必然需要阅读过往的旧代码,这时候可读性高的代码,则显得尤为重要。我们应该做到以下几点

名副其实 变量,函数或者类得名称会告诉你,它是干什么的,做了什么,有什么用,如果需要注释,那不算名副其实。比如一个 int d;//当前时间,这样的变量应该这样命名,int currentTime;这样很清晰地就表现出来变量是什么意思。

避免误导 在日常开发中,避免使用意思掩藏代码本意的错误线索,不该使用类似hp之类的专有名称。这样会带来误导。还有名称不同之处很小的变量。这些都比较容易让后续的开发人员误导。

使用读得出来的名称 意思就是尽量避免使用中式英语,而应该使用日常的英语单词来表达意思。

类名 一个类或者接口的名字就应该是名词,而不应该是一个动词

小总结

做个编程的都知道,在日常的工作中,都或多或少地被亲爱的同事又或者是已经离职的某位仁兄的代码绊倒过,甚至被那些糟糕的代码严重拖迟着自己的进度,可想而知,在修改的过程中,在读他人的代码过程中,那种一把心酸一把鼻涕的感觉有多么难受,对于代码的修改也经常会出现修改了两三处地方,就有可能别的地方连带出现问题,这种情况本人也是碰到不少,需要对源代码读懂才能避免这种错误的发生,随着这种混乱的发生,可想而知,团队的生产力必然会越来越低,在我看来必须从自身做起,写出一首优雅的代码,尤为重要,写出优雅的代码不是一日之功,那么就先从小处做起,良好的命名真心尤为重要,日常读同事的代码,有时候真是太难以理解了,单词不完整,过于简洁,不看注释都有点难以明白这个函数到底用来干什么,函数里面的调用函数也是,个人认为做到以上几点非常地有必要,起码读代码的效率会高上不少。

相关文章

  • Clean Code 阅读笔记一

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

  • Clean Code 阅读笔记二

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

  • Clean Code 阅读笔记三

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

  • Clean Code 阅读笔记五

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

  • Clean Code 阅读笔记六

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

  • 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 Architecture,这是我秋天的

    什么是Clean Architecture The Clean Architecture是《Clean Code》...

网友评论

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

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