《代码整洁之道》读书笔记

     因为本人是一个小菜鸟，所以需要在很多地方下功夫，最近突然发现自己的代码规范还是差很多，没有系统的去学习代码规范的相关东西，所以打算补一下这方面的缺陷，毕竟不管是工作多少年的人，在这方面大多人都很难拥有一个良好的编程风格和代码规范。在此记录下读书过程中摘抄的一些笔记，方便以后的查阅。

1、勒布朗法则：稍后等于永不！

    所以，不要想着留着以后去做，因为以后永远都不会去做了，最好是一开始就做好。

2、整洁的代码只做好一件事。

3、代码“优雅”至关重要。

4、代码中最好不要使用硬编码数字，这些数字最好是用const常量表示，且要见名识义。但是变量初始化为0这些就用数字即可。

5、有意义的命名：

（1）名副其实：如果名称需要注释来补充说明，那就不算名副其实；

（2）避免误导；

（3）类名和对象名应当是名词或者名词短语，类名不应当是动词。

（4）方法名应当是动词或动词短语。

6、函数：

（1）函数的第一规则是要短小。函数越短小越简单，逻辑越简单明了越好。

（2）函数应该只做一件事。

（3）函数名称最好使用描述性的名称，最好能描述函数所做的事情。函数越短小，功能越集中，越便于取个好名字。

（4）函数参数：最理想的参数数量是0。

    1）标识参数：

注意：如果函数可能需要3个以上的参数，那就说明其中一些参数应该封装成类了。

      2）参数的顺序：

      参数的顺序也是值得考虑的一件事，最好可以让人很容易记住函数参数都有哪些，比如下面例子：

     3）无副作用：

    4）使用异常替代返回错误码或者打印错误日志

    5）抽离try/catch代码块

   6）Error.java依赖磁铁

7、注释

     如果你发现自己需要写注释，那么就需要想想看，能否用代码来表示，其实最好的注释就是代码。能用代码来表示的时候最好不要写注释，因为程序员不能坚持维护注释。

     如果需要写注释，我感觉主要还是函数或者变量的命名不够好。

下面几种情况可以写注释：

1）警示

      警告程序员这块代码会出现某种后果的注释。

2）TODO注释

      TODO是一种程序员认为应当做，但由于某些原因目前还没有做的工作。

8、格式

    先明确一下，代码格式很重要，代码格式关乎沟通，而沟通是专业开发者的头等大事。

1）垂直格式

      类似于报纸，从上到下阅读，简单且有条理。代码中空白行隔开了概念，靠近的代码则暗示了它们之间紧密的关系。

      （1） 变量声明尽可能靠近其使用位置。

      （2）如果某个函数调用了另一个函数，就应该把他们放在一起。被调用函数应该放在执行调用函数的下面。即建立自顶向下贯穿源代码模块的良好信息流。

2）横向格式

9、对象和数据结构

      将变量设置为私有，是不想让别人依赖和看到这些变量。

10、类

     类应该短小