代码整洁之道笔记(二)

代码整洁之道笔记(二)

第三章 函数

本章主要对于怎样写出一个好的函数给出了几点建议：

• 短小

  函数的第一规则是要短小，第二规则则是还要更短小

• 只做一件事

  函数应该做一件事。做好这件事。只做一件事

• 每一个函数一个抽象层级

  函数中的语句都要在一个抽象层级上，要让代码拥有自顶向下的阅读规则（向下规则）

• 使用描述性的名称

  选择描述性的名称能理清你关于模块的设计思路，并帮你改进之.

• 函数参数

  最理想的参数数量是零个其次是一个，然后是两个，应避免使用三个或者三个以上的参数。

• 分隔指令与询问

  函数要么做什么事，要么回答什么事，二者不可兼得。

• 使用异常替代返回错误码

• 不要重复自己，不要有过多的重复代码

最后作者对于如何写出满足上述规则的函数，就是对于写好的代码慢慢打磨，慢慢来，没有人一开始就按照规则写函数。

第四章 注释

这一章读者就是传递一个概念：可以通过代码来表达意图的都不要用注释，注释是根本不需要的。但是也说了有的注释是必须的，这些被称为好的注释。所以这一章主要是给出了好注释是那些，坏的注释有事那些

好注释

• 法律信息
• 提供信息的注释
• 对意图的解释
• 阐释
• 警示
• TODO注释
• 公共API中的Javadoc

坏注释

• 楠楠自语
• 多余的注释
• 误导性注释
• 循规式注释
• 日志事注释
• 废话注释
• 能用函数或变量就不要用注释
• 位置标记
• 括号后面的注释
• 归属与署名
• 注释掉的代码
• HTML 注释
• 非本地信息
• 信息过多
• 不明显的联系