《代码整洁之道》pg1-pg38笔记

1、使用 @author。
2、近10：1 的读写时间，让代码易读，就易写了。
3、没有重复代码。
4、整洁的代码只做好一件事，易于修改。
5、不羞于告知自己的想法，以热情卫护代码。
6、选个好名字要花时间，但省下来的时间比花掉的多。一旦发现有更好的名称，就换掉旧的。如果名称需要注释来补充，就不算是名副其实。
7、避免误导。提防使用不同之处较小的名称。
8、做有意义的区分。废话都是冗余。如果程序员只是为满足编译器或解释器的需要而写代码，就会制造麻烦。
9、使用读得出来的名称。如：genymdhms 替换为 generationTimeStamp。
10、名称长短应与其作用域大小相对应。若变量或常量可能在代码多处使用，则应赋其以便于搜索的名称。
11、应当把类和函数做得足够小，消除对成员前缀的需要。
12、类名和对象名应该是名词或名词短语。方法名应当是动词或动词短语。属性访问器、修改器和断言应该根据其值命名，并依JavaBean标准加上get、set 和 is 前缀。重载构造器时，使用描述了参数的静态工厂方法名。
例如，Complex fulcrymPoint = Complex.FromRealNumver(23.0);
通常好于 Complex fulcrumPoint = new Complex(23.0);
可以考虑将相应的构造器设置为private，强制使用这种命名手段。
13、给每个抽象概念选一个词，并且一以贯之。
14、只有程序员才会读你的代码。所以，尽管用那些计算机科学术语、算法名、模式名、数学术语吧。依据问题所涉领域来命名可不算是聪明的做法。因为不该让协作者老是跑去问客户每个名称的含义，其实他们早该通过另一名称了解这个概念了。
15、添加有意义的语境。你需要用有良好命名的类、函数或名称空间来放置名称，给读者提供语境。语境的增强也让算法能够通过分解为更小的函数而变得更为干净利落。
16、只要短名称足够清楚，就要比长名称好。别给名称添加不必要的语境。
17、函数的第一规则是要短小，第二条规则还要更短小。20行封顶最佳。if语句、else语句、while语句等，其中的代码块应该只有一行。该行大抵是一个函数调用语句，函数该拥有较具说明性的名称。
18、每个函数一个抽象层级。函数中混杂不同抽象层级，往往让人迷惑。读者可能无法判断某个表达式是基础概念还是细节。更恶劣的是，一旦细节与基础概念混杂，更多的细节就会在函数中纠结起来。
19、别害怕长名称，长而具有描述性的名称，要比短而令人费解的名称好。长而具有描述性的名称，要比描述性的长注释好。使用某种命名约定，让函数名称中的多个单词容易阅读。
20、参数与函数名处在不同的抽象层级，它要求你了解目前并不特别重要的细节。从测试的角度看，参数甚至更叫人为难。输出参数比输入参数还要难以理解。输出参数往往让人苦思之后才恍然大悟。