clean code（代码整洁之道）

一、有意义的命名

示例1

示例2

示例3

示例4

图一

图二

 图三

示例5

示例6

示例7

示例8

二、函数

1.尽可能短小

2.只做一件事

如果对你写的某个方法的代码进行审查时 发现他做了多件事 这些事中的某些小事 在其它地方也会做，或者你觉得在将来会被其地方用到，那么这个时候就涉及到代码的重用性或者说是重复度问题，那么这个时候就需要把这些小事独立抽取成一个方法，同时这样做也恰好满足了上面第一点函数行数尽可能短的原则

3.分隔指令与询问

三、注释

1.别给糟糕的代码加注释

2.注释紧贴其相关代码

3. 尽量用代码来表达你的意图

比如 如下将 几个判断放到函数中 函数名则告知其意图 ， 尽量用函数或者变量名来替代注释

4.必须要写的注释

5.TODO注释的管理

6. 公共API尽可能编写javadoc

7. 糟糕的一些注释案例

 拿注释当标记

直接注释代码

四、格式

1.空行 与紧贴

封包声明 与第一个导包语句空行 相关的变量定义紧贴 不相关则考虑空行 最后一个成员变量

与第一个方法之间空行 方法与方法之间空行  

2.局部变量声明尽可能靠近它被使用的地方 

3.实体变量应该在类的顶部声明

4.相关函数放一起

 参数之间的空格 赋值，运算符的左右空格

 

5.注意缩进

对比下面两段代码 一些空行 一些缩进 能极大增强代码的可读性

 

6.符合编码标准的优秀代码示例

7.循环时 不要用 ； 来代替 空的语句体 

五、对象与数据结构

写代码时考虑其或许可能的多态性

说人话 ：参数如果能用接口那么不用具体实现类，  就是看以下两段代码 多态式添加一个shape接口类 area方法后续的维护会变得更简单甚至不用动

过程式代码

多态式代码 

 

 

六、思考错误处理

1.尽量不返回null 

比如 我们如果在返回值为list类型，其值为空时 可以返回 Collections.emptyList() 而非null，来避免调用者没判断是否为null而直接使用返回list对象而产生的空指针问题

 

2.使用异常来提示由于 某参数传递为非法时带来的问题

比如如下

 

七、类

1.组织与排列

2.内聚

 

3.隔离修改 

啥意思呢,就是能依赖父类不依赖子类,能依赖接口不依赖实现