读《代码整洁之道》小结 🙂

昨晚无聊看到公司书架上有一本《代码整洁之道》自己就翻了翻。觉得还是有收获的。但是书里面好多章节是一大堆代码放在那边的。我基本就直接跳过了。看了个标题就过了。走马观花的浏览了。然后也看了下别人写的观后感。自己记录一下 自己用得到的--有的我觉得我能力不够还理解不了 太菜~

封面还挺好看

1.命名

• 使用标准命名方法-命名要具有表现力以及准确性-见名知其意
• 类名应当是名词或名词短语，方法名应当是动词或动词短语
• 每个概念对应一个词
  (比如query...、update... ) 如果使用了这个格式，其他相同类型的也用这样的格式 简单易懂
• 做有意义的区分
  不要使用意义相近的名称，比如ProductInfo和ProductData变量不同，意思一样，容易引起意义混淆

---

2.函数(方法):

• 别重复自己,相同的方法一定要封装！！一定！！一定！！一定！！
• 一个函数只做一件事
• 函数的入参尽量少 1 到2个入参即可
  如果多于3个的话。可以整合成对象。避免传boolean的值 true/false 如果是这样的话 直接拆分成2个函数-我之前就这样传 要更正
• 函数尽量小-拆分的细点
  这个有点争议:一个例子 手机修理小零件的收纳盒 基本是很多个小格子.这样找起来很方便，看上去也很整洁
• 每个函数一个抽象层级
  我的理解是 函数中的方法 最好都在同一个文件中方便找~
• 函数里面不要返回null 或者特殊的对象

---

3.注释:都说代码及文档,但是很难啦-

好的注释：

• 对意图的解释-或提供思路
• 法律信息、许可证、版权、著作权、外链文档的 url 添加注释
• 特定的变量提供说明
• 警告⚠️的提示
  会有一些你也搞不定的现象。那一行代码 看着的确没用。但是你删了就爆炸。你也不知道原因的。这个基本是历史的原因
• TODO的注释 避免疏忽忘记

坏的注释：

• 注释掉的代码 不用的代码直接删除！！！！
• 别加位置标记 我就干过这事,进行分割代码
///////////////////// Actions //////////////////////////
• 别加废话注释 自言自语`
• 多余的注释。本身并不能比代码提供更多的信息，就是多余。
• 源码自带的信息注释-其实没啥信息 工具生成的`

---

4.代码格式:

• 靠近: 紧密相关的代码应该互相靠近
• 变量声明应尽可能靠近其使用位置,全局变量声明在类的顶部
• 调用者放在被调用者上面，这样就能轻易找到被调用函数，极大增强模块的可读性
• 注意代码缩进 代码行长度控制在100-120个字符

5.异常处理:

• 将try包含的代码块抽象成一个函数
• 对待每一个异常都需要详细处理，不能归咎成偶然事件

大概总结了这么多-我觉得是我自己平常会存在的问题。以后尽可能避免出现这样的错误~ 在贴一张别人总结的脑图-《代码整洁之道的目录思维导图可以看一下： 思维导图