《代码整洁之道》推荐给每一位有志于写出优秀代码的程序员，这是一本我从事程序开发多年后，所读到的对我触动颇深，相见恨晚之作。不夸张的说，这应该作为每一个程序工作者初入职场的必读之作。当然关于读书，任何时候起步都不算晚。本书，Martin大神会告诉你，好代码的意义，并教你如何写好代码。
下面结合自己多年工程实践的经验和书中作者的观点，整理出以下简单易记的代码整洁之道，愿帮助到大家写出简洁优雅的代码。
代码整洁的意义？
整洁的代码便于阅读，传承，维护。
整洁的代码直接关乎团队生产效率的提升，甚至关乎团队存亡。
什么是整洁代码？
整洁的代码应该可以由作者之外的开发者阅读，增补，它应该有单元测试和验收测试，它使用有意义的命名。它只提供一种而非多久做一件事情的途径，它只有尽量少的依赖关系，而且要明确地定义和提供清晰、尽量少的API。
如何写出整洁代码？
注释：
- 消除冗余注释，无意义的注释，尽量用有意义的变量名，有意义的方法名来达到代码注释的效果，因为维护注释很困难
- 注释掉的代码，用版本管理工具管理代码，当前无用的代码，果断删掉，这种腐烂掉的代码会严重污染所属模块，影响代码的可读性，阻碍代码阅读者准确的理解代码
函数：
- 函数的参数应尽量少，参数过多时改考虑是否应该抽取对象了
- 避免输出参数（将输入的参数作为输出结果的载体，比如输入一个空的 hashmap，然后再函数中填充hashmap值）
- 避免传入bool 变量的参数 ，这会影响代码的可读性，传入bool变量说明函数做了不止一件事情（违背SRP单一职责原则）比如：setSwitchStatus（On/Off) ===> 拆为： switchOn（） switchOff（）
- 死函数，删除永不调用的函数
一般性问题:
- DRY (don't repeat yourself) 避免代码重复，当出现代码重复时，意味着遗漏了抽象
- 死代码 永远不会执行的代码应该删掉
- 前后不一致问题，变量命名规则，框架的使用，代码风格，一旦确定，坚决贯彻
- 使用解释性变量
- 函数名应该表达其行为
- 用多态代替 switch/if/else
- 用命名常量代替Magic number
- 封装条件，if (true)… 最好修改为 if (fileExist(..))….
- 一个函数只做一件事情（ SRP） 优点解耦，更灵活
- 掩盖时序耦合，如果几个函数有调用时序关系，请通过参数或者返回值的形式建立他们的时序关系，比如：每个函数产生下一个函数所需要的结果
- 封装边界条件，比如 if（currentPage > 10) … 最好改为if（isLastPage（currentPgae） 这样阅读者更容易读懂代码的意图
- 避免传递性浏览（墨忒耳律），如果A与B协作，B与C协作，避免A.getB.getC 这样的操作，而应该直接用B.doSomething() 将与C 相关的逻辑封 装在B 的 方法里面
网友评论