阅读《代码整洁之道》的一些记录

一些记录

1. 无论是变量、函数、类的名字都要取有意义的名称；
2. 函数的功能要尽可能保持单一简单，即单一职责原则；
3. 函数的参数个数也不易太多，一般不超过三个，超过三个应该考虑使用类去封装或者分解函数内容；
4. 函数的参数一般都作为输入参数，输出参数尽量修改为返回值来统一返回；
5. 代码注释也应该保持简洁易懂，不要做无意义的注释，比如，编写日期，编写人，版权信息等这些注释信息都可通过版本控制软件来体现；
6. javadoc注释一般用于外部接口，内部代码的注释一般不建议使用。

一些设计原则

• 单一职责原则 Single Responsibility Principle (SRP)
  描述的是每一个类都只负责单一的功能，切不可太多，并且一个类应当尽量的把一个功能做到极致；
• 里氏替换原则 Liskov’s Substitution Principle (LSP)
  描述的是一个子类应该可以替换掉父类并且可以正常工作；
• 接口隔离原则 Interface-segregation Principle (ISP)
  描述的是接口最小化原则，强调的是一个接口拥有的行为应该尽可能的小；
• 依赖倒置原则 Dependency Inversion Principle (DIP)
  描述的是顶层模块不应该依赖于底层模块，二者都应该依赖于抽象类，抽象类不应该依赖于细节，细节应该依赖于抽象；
• 迪米特法则 the Law of Demeter (LOD)
  描述的是最小知道原则，一个类应该尽量不要知道其他类太多的东西，不要和陌生的类有太多的接触；
• 开放封闭原则 Open-Close Principle (OCP)
  描述的是软件实体（类、模块、函数等等）应该尽量保持对扩展是开放的，对修改是封闭的。