【读书笔记】- 代码整洁之道

代码整洁之道

概要：

杂谈

分章总结

--------------------------------------------------------------------------------------------

杂谈

     谈及代码整洁，大的方面是关于一个系统的演变后的模样，好比混沌的创世，到有了法治文明。小的方面是家庭的标准、家规等等。例如系统间的协议、约定、通用性等。合理的方式都是整洁的一种表现。而非整洁就会让系统面目全非。越到后面越难以维护。只能走重构的路，可是真的有能力重构吗？人员的流失，对业务的掌握并非是知识的能及范围。可能导致事故。所以不断的code review是必要的。在过程中去沉淀，思考。而不是让系统跑起来就是完工，是思考系统如何以一种优雅的方式运行，去接收新新需求，但要预防过度设计，夸夸其谈未来需求。改进的道路是基于历史的痕迹上构建的。能实现高内聚的时候就组合成团，组件化。还不成熟的，要清晰易懂，不要写反逻辑、过多的抽取，可能有些是共用的，但是想想收益真的好嘛。书中给的基础的。常识性的一定要遵守，这是公认的，也是基础。在基础上的任何扩展，只要满足本质目标，都是正确的。下面是章节觉得有价值的摘录。小记一下。

--------------------------------------------------------------------------------------------

分章总结

第一章：整洁代码

艺术书并不能保证你度过之后能成为艺术家，只能告诉你其他艺术家用过的工具、技术和思维过程。本书同样也不能担保让你成为好程序员。它所能做到的，只是展示好程序员的思维过程。还有他们使用的技巧、技术和工具。

第二章：有意义的命名

1、名副其实
    降低代码的模糊度。
    减少魔术数的使用。
    减少误导性名称的使用。（相似词汇、a1，a2...）
    降低废话的使用（废话是另一种没有意义的区分。假设你有一哥Product类，如果还有一个ProductInfo或者ProductData类，那么他们的名称虽然不同，意义却无区别。info和data就像a、an和the一样，是意义含糊的废话）
        举例：moneyAmount就与money没区别
    使用读得出来的名称
    使用可搜索的名称
    明确是王道
    类名应该是名词或名词短语。如Customer、WiliPage、Account避免使用Manager、Processor、Data或Info这类名。类名不应该是动词。
    方法名应该是动词或动词短语。如postPayment、save。属性访问器、修改器和断言应该根据其值命名。并依照JavaBean标准加上get、set和is前缀。
    每个概念对应一个词。
    别用双关语
    只有程序猿才会读你的代码。尽量使用那些计算机科学术语、算法名、模式名。
    同一个变量的含义不要在系统中出现类似名称要统一，统一，统一！！！

第三章：函数

    函数的第一规则要短小。第二条规则是还要更短小。那么多少算小。个人理解，函数表意。达到描述含义，函数自然不会大，最小单元。
    函数应该做一件事。做好这件事，只做这一件事。总览型（步骤）方法前可加TO。
    函数参数：最理想的参数数量是零、其次是一、再次是二、尽量避免三。参数不易对付，它们带有太多概念性。
    函数要么做什么事，要么回答什么事，但二者不可兼容。
    错误处理就是一件事。
    依赖磁铁（如错误码）慎用。
    
    如何写出这样的函数：
        一开始必然是冗长而复杂的。（避免提前抽象）；配合单元测试。在OK以后，进行方法拆解。满足以上原则，打磨，分解函数，修改名称，消除重复。缩短和重新安置方法。有时会拆散类，同时保持测试通过。
    大师级程序员把系统当做故事来讲，而不是当做程序来写。他们使用选定的编程语言提供的工具构建一种更为丰富且更具表达力的语言，用来讲那个故事。

    
第四章：注释

    别给糟糕的代码