编码技巧 笔记

1012编写可读代码的艺术 阅读笔记

表面改进

1.代码应当易于理解

可读性: 代码的写法应当使别人理解它所需的时间最小化

2.将信息装入名字里

• 选择专业的词
• 避免泛泛的名字
• 用具体的名字代替抽象的名字
• 使用前缀/后缀给名字附带更多信息
• 决定名字的长度
  • 小作用域短名字
  • 首字母缩略词– 需要易于理解
  • 丢掉没用的词
• 利用名字的格式表达含义

3.不会误解的名字

4.审美

1. 使用一致的布局,让读者很快习惯这种风格
2. 让相似的代码看上去相似
3. 把相关的代码行分组,形成代码块

5.该写什么样的注释

不该写什么注释?

1. 不要为那些从代码本身就能快速推断的事实写注释
2. 不要为了注释而注释
3. 不要给不好的名字加注释–应该把名字改好

该写什么?

1. 记录思想

   记录写代码时有过的重要想法

   1. 比如加入”导演评论”

2. 为代码中的瑕疵写注释

3. 给常量加注释

4. 公布可能的陷阱

5. 全局观注释–类之间如何交互等

6.写出言简意赅的注释

1. 让注释保持紧凑
2. 避免不明确的代词
3. 润色粗糙的句子
4. 精确描述函数行为
5. 用输入输出例子来说明
6. 声明代码意图
7. 采用信息量高的词

逻辑改进

7.把控制流变的易读

1. 比较语句

   左侧倾向于变化值,右侧倾向于固定值

2. 最小化嵌套

   提前返回

   这是个好事

8.拆分超长表达式

思想:拆成小块

9.变量与可读性

• 减少变量
  • 去掉没有价值的临时变量
  • 减少中间结果
  • 减少控制流变量
  • 缩小变量的作用域

重新组织代码

10.抽取不相关的子问题

如果一段代码并不是为了这个代码块的高层次目标直接工作,可以将其抽取处理.

11.一次只做一件事

如题

12.把想法变成代码

最好按自然理解的逻辑组织代码