代码整洁之道读书笔记

整洁代码

有意义的命名

1. 名副其实：选好的命名要花时间但是省下的时间比花掉多，一旦发现更好的名称可以替换旧的。
2. 避免误导：以同样的方式拼写相同的概念才是信息，拼写前后不一致就是误导，举例比如小写字母l和大学字母O作为变量名产生误导。
3. 做有意义的区分：如copyChars(String s1,String s2) s1可以改成source 、s2改成destination
4. 使用读得出来的名称：如private Date geymdhms 可改成generationTimeStamp
5. 避免使用思维映射
6. 类名：名词或者名词短语
7. 方法名：动词或者动词短语
8. 别用双关语
9. 使用解决方案领域名称，比如queue（队列）、factory（工厂）
10. 添加有意义的语境比如addFirstName

函数

1. 短小

2. 只做一件事，判断是否只做一件事的方法：

   函数中每一步骤是否都在同一抽象层上，

   能否再拆出一个函数

3. 自顶向下读代码，向下规则

4. 使用描述性的名称

5. 函数参数

注释

类

总结

• 代码质量与整洁度成正比
• 勒布朗法则：稍后等于永不
• 破窗效应，烂代码只会越来越烂

---

• 本文标题： 代码整洁之道读书笔记
• 文章作者： sherryriver（木木三可）
• 发布时间： 2017.06.01
• 本文链接： https://sherryriver.github.io/2017/06/01/代码整洁之道读书笔记/
• 许可协议： "署名-非商用-相同方式共享 4.0" 转载请保留原文链接及作者。