代码整洁总结笔记

命名

• 名副其实：

一眼就能看起是啥意思，避免拼音，1,2,3那种

• 做有意义的区分

customerInfo与customer就没有区别，data与dataInfo也没有区别

• 有意义能搜索的名字：

比如7数值很难找，MAX_APP_INDEX 就好找多了

• 不一样非要用前缀:

m_之类的，看多了也是很容易忽略，变成废料

• 接口与实现：

这个我是喜欢加前缀的，比如ICallBack

• 类名：

用名词

• 方法名：

用动词

• 同类型命名：

可以约定一个前缀，方便查找分类

函数

• 短小：

能短小就尽量短小，越短小越容易看得懂

• 一个方法做一件事：

单一职责原则最好

• 避免多参数：

建议最好不要超三个参数，参数越少越好，多个参数可以封装为一个参数对象传递

• 避免标识参数参数：

参数传入boolean进行判断，其实可以转为两个方法

• 使用异常代替返回错误码：

如果主流程的多个步骤，这些步骤方法有对应的错误码，这些错误码决定了它下一步的执行，那样主流程就有多个if判断嵌套。可以通过异常代替错误码，主流程一个try catch就行
这个我是保留意见的，我觉得出现这种代码的概率很小，毕竟不同错误码决定不同的结果，无法统一处理异常

• 避免重复代码

重复代码可以提取方法，这样好处就是可以统一修改不用多个维护，并且减小代码量

• 如何写

不用纠结，可以开始随心写，写完花点心思整理下代码就行，记得养成这个习惯

类

• 遵循约定

类开始应该是变量列表，公共静态常量最先出现

• 单一职责

类应该单一职责，不应该多参杂

糟糕的代码

• 重复代码
• 过长的函数，函数越短越好
• 过大的类

1.多的变量可以将关联的提到新对象
2.去掉重复代码
3.数据与ui分类，mvp架构
4.先确定流程与行为，再编写接口，再写对应的实现

• 过多的参数
• switch使用过多
• 数据各处放，没有统一
• 冗余类（通过内部类解决）
• 过渡设计，觉得以后会用到
• 过多的注释

复杂功能代码设计

• 先设计，把流程图整理清楚、合理、完善
• 面向接口编程