进步代码可读性,控制这些就够了

进步代码可读性,控制这些就够了

本日看到一篇关于代码优化的文章,写得非常有用,在进修总结后,梳理出头脑构造图,将收货的分享一下

原作者:方应杭

原文地点:https://zhuanlan.zhihu.com/p/…

注重:这篇文章所指的代码优化,特指的是代码可读性方面的一些写法优化,而不是指的机能优化。

下面是我总结的一份头脑导图,轻易构成对文章内容构造的一个大抵的印象。

《进步代码可读性,控制这些就够了》

首先是关于代码优化的几条准绳:

  • 易读性优先
  • 假如不是机能瓶颈题目,不要只是为了机能优化而改写代码
  • 没有银弹。不管怎样写,代码的庞杂性不会消逝。

关于第三条,作者也诠释了,假如你这个功用逻辑一句话能说清,那你一定不应该写上百行那末庞杂,假如10分钟也讲不清楚的功用,代码也一定会表现出功用的庞杂。

一、怎样定名代码

这里讲的是程序员的三大困难之一,变量定名。

包含两大点:

  • 要注重词性,包含6小点。
  • 注重一致性(作风一致),包含4小点。

1.注重词性

  • (1) 平常变量的定名,平常就用「名词」
 name: 'lvziwei',
 age : '18'
  • (2) 布尔范例变量的定名,用「isX」或许「hasX」或许「canX」
    isVip:  true              示意是VIP
    hasValue: true            示意有值
    canSpeak: true            示意能够措辞
  • (3) 函数是一个行动,固然用「动词」
     run(){}, // 不及物动词
     drinkWater(){}, // 及物动词
  • (4) 函数中,假如是回调函数。用「介词」开首,或用「动词的如今完成时态」

「介词」开首

    beforeUpdate()
    afterUpdate()

「动词的如今完成时态」, 典范的是Vue的生命周期钩子函数。

     var component = {
          beforeCreate(){},
          created(){},
          beforeMount(){},
          mounted(){},
          beforeUpdate(){},
          updated(){},
          activated(){},
          deactivated(){},
          beforeDestroy(){},
          destroyed(){},
          errorCaptured(){}
      }

这两种写法都很轻易读,然则注重你最好只挑选一种作风写法并坚持,这也是下面将要提到的一致性。

  • (5) 迥殊的 : 一些轻易殽杂的变量,能够增加前缀来让他们更轻易读
    var dom1 = document.querySelector('#dom1')
    var dom2 = $('#dom2')
    
    // 如许的代码不轻易读,由于dom1 dom2直觉上觉得是一类的,然则一个是dom对象,一个是JQ对象
    
    // 前缀优化: 可通过变量称号,一眼看出他们一个是DOM,一个是JQ对象
    
    var dom = document.querySelector('#dom1')
    var $dom = $('#dom2')
    
    
  • (6) 迥殊的 : 属性接见器函数,能够用名词

这是一种约定成俗的定名体式格局吧,按说函数都用动词,然则你看到一个框架里的函数API是用的名词,那末这极能够定时这个函数是一个属性接见器。

JQ中的text()

$dom.text()
$dom.text('内容1')

2.注重一致性(作风一致)

  • (1) 作风一致

上面提到过,下面2种作风,最好只挑选其一。

     beforeUpdate()
     afterUpdate()
     beforeUpdate(){},
     updated(){},
  • (2) 函数名和函数体一致

    函数称号准确的形貌函数体内容,函数内容要表现函数称号

  • (3) 时候一致

    跟着时候推移,营业的转变能够致使当初的变量称号已不再适宜,这时候要实时修正,这也是最难做到的,由于牵一发而动全身。

二、怎样构造代码

好了,如今我们的变量称号已易读,轻易理解了,以后干吗?

是否是就剩下将你的变量构造起来了? 下面主要从两方面讲了怎样构造代码

1.用函数构造你的代码

步骤:

  • 将一坨代码放到一个函数里
  • 将代码依靠的外部变量作为参数
  • 将代码的输出作为函数的返回值
  • 给函数取一个适宜的名字
  • 挪用这个函数并传入参数
  • 这个函数里的代码假如凌驾 5 行,则依旧有优化的空间,请回到第 1 步

2.用对象构造你的代码

我们会用 this 来串连这个对象和一切函数。
终究代码:http://js.jirengu.com/mimazab…

3.一些牢固套路

  • 表驱动编程(《代码大全》里说的)
    一切一一对应的关联都能够用表来做
  • 自申明代码(以 API 参数为例)
    把他人体贴的东西放在显眼的位置

三、怎样写一手烂代码

角度清奇,原作者引荐了一篇教人怎样写出不可保护的代码的文章 : https://coolshell.cn/articles…

    原文作者:Ziwei
    原文地址: https://segmentfault.com/a/1190000012947459
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞

发表评论

电子邮件地址不会被公开。 必填项已用*标注