读《代码整洁之道》笔记（一）

一．整洁代码的作用？为什么？

编写整洁代码的程序员就像是艺术家，用优雅高效的代码构筑成强大的系统。
整洁高效的代码可以起到事半功倍的效果。

二．有意义的命名

1.类的命名

用名词或名词短语（Customer）,不应当是动词。

2.方法的命名

用动词或动词短语（deletePage）
 

三．函数

• 函数行数不宜过长，20行封顶；
• 函数只做一件事，并且做好这件事；
• 要确保只做一件事，函数中的语句都要在同意抽象层级上；
• 命名使用描述性的名称；
• 函数最理想的参数数量是零（最佳），其次是一，再次是二，尽量避免三个参数；
• 避免有重复代码；
• 在写代码开始时，想到什么写什么，然后去打磨它，起初也许会粗陋无序，你就斟酌推敲；

四．注释

• 尽量使代码代替注释；
• 好的注释：法律注释、提供信息的注释、对意图的解释、阐释、警示、TODO注释、公共API中的Javadoc
• 坏的注释：喃喃自语、多余、误导性注释、循规式注释、日志式注释、废话注释、能用函数或变量时就别用注释、位置标记、括号后的注释、归属与署名、注释掉的代码、HTML注释、非本地信息、信息过多、函数头（选个好名字）。

五．不明所以的地方