童子军法则:让离开的时候比来的时候干净一些。

有意义的命名
- 类名(名词性)
- 方法名(动词性)
- 变量名(精准不混淆)
函数
- 只做一件事(只做和函数名相关的事)
- 短小(函数不同该冗长拆分不同逻辑层次)
- 参数(不传入多个参数)
- 垂直距离(相关的函数调用放在垂直距离近的位置)
- 逻辑层级一致(函数中避免出现不该做的事,从顶而下来处理而不要多做底层的事)
- 减少if else使用(减少复杂的流程控制,使用枚举,switch状态机,多态)
类
- 类的组织方式(摆放方法和变量的位置)
- 短小
- 内聚避免耦合
注释
- 删除注释的代码
- 只保留必要的注释
- 合适的注释有利于代码的理解
格式
- 编译器做了大部分工作
网友评论