代码整洁之道

减少抽象代码 提高表达力 提早构建简单抽象代码

命名

避免使用意义相悖的命名 避免使用相似易误解的命名
避免使用没有意义的命名
使用可搜索的名称 即在全局中不要出现太多
避免除循环外的单字母命名
类名是名词，方法名是动词
函数名称应该独一无二，且保持一致

函数

if语句 else语句 while语句代码块应该只有一行
函数应该只做一件事, 每个函数只有一个抽象层级
函数参数尽量避免三个及以上: 避免信息通过参数输出
标志参数不要传布尔值
避免使用用参数做输出的函数 或者这样做 get_field(report)改成 report.get_field()
函数要么做什么事，要么回答什么事，二者不可兼得，最好不要做什么事再返回成功了没有。
返回错误码轻微的违反了规则，可以用try /catch 来处理错误
错误处理就是函数的一件事，应该就是函数的主体，try和finally前面后面都不该有东西

注释

有时间写大量注释，不如优化代码
代码能够阐述含义
唯一真正好的注释是想办法不写注释
值得写注释的 法律信息，对意图的结束 ，警告，认为应该写而没有写的东西

格式

单个java文件应该在200~400行之间
垂直方向 紧密联系的代码应该互相靠近
概念上垂直方向上间隔记得要空格
变量声明应尽可能靠近其使用位置
变量声明应该在类的顶部声明