笔记 编写可读性代码的艺术

浏览原文

《笔记 编写可读性代码的艺术》

1. 代码应该易于明白

  • 唯一标准:让他人明白的时刻最小

2. 把信息装到名字里

  • 挑选专业的词
  • 防止平常的名字
  • 运用详细的名字替代笼统的名字
  • 为名字照顾更多的信息
  • 名字的作用域越大,最好名字越长
  • 丢掉没用的词
单词更多挑选
senddeliver, dispatch, announce, distribute,route
findsearch, extract, locate, recover
startlaunch, create, begin, open
makecreate, set up, build, generate, compose, add ,new

3. 审美

我之前学设想的时刻看过一本书,写给人人看的设想书(第3版)将这本书中的设想审美道理应用到写代码上,实在非常贴切,假如你读过此书,你的审美才能会大幅进步。

  • 对齐
  • 反复
  • 对照
  • 亲密性 根据亲密关系分段
  • 递次

《笔记 编写可读性代码的艺术》

4. 写什么样的诠释

  • 不要写一眼就能够看懂的诠释,类似于欲盖弥彰
  • 与其写诠释,不如把变量名函数名写好,能够从名字中明白
  • 纪录你的头脑
  • 到场批评
  • 指出那里有圈套,须要注重
  • 一针见血,不要烦琐
  • 不要运用不明确的代词,不要像像算命先生措辞,怎样诠释都对

5. 可读性掌握流

  • 寻求最小明白时刻,而不是起码代码行
  • 只管提早return效果
  • 少点嵌套,要只管扁平化
  • 明白实行流程。有些是一连实行。有些是随时都能够实行,像事宜回调
  • 防止运用while, 平常我们轮回都是为了遍历数组,为何不必forEach呢?

6. 拆分超长表达式

  • 拆分超长的表达式
  • 拆分庞大的语句
  • 只管把逻辑包裹在函数中,不要反复你本身 DRY

7. 变量与可读性

  • 削减变量,变量越少越好
  • 削减中心效果,垂直消耗
  • 削减用于掌握流的变量
  • 减少变量的作用域
  • 用到变量再定义,不要提早定义,不然还要随时想着,之前定义的变量是用干吗的呢?

8. 重构

  • 抽取不相关的自子题目
  • 抽取种种设置性的变量在一起,他们都是设置
  • 只管写纯函数
  • 建立大批通用代码
  • 打造本身的兵器装备库
  • 简化接口授参
  • 矫枉过正,不要太刻薄

9. 一次只做一件事

10. 少写代码

  • 最好的代码就是没有代码
  • 别劳神完成谁人功用,你不会须要的
  • 质疑和拆分的需求
  • 坚持小代码库
  • 删除没用的代码
  • 删除没有的诠释

11. 调试

  • 只管将毛病打印出来,不要隐蔽
    原文作者:Carl
    原文地址: https://segmentfault.com/a/1190000013763031
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞