作家
登录

JavaScript的API设计原则

作者: 来源: 2017-06-19 17:57:51 阅读 我要评论

  1. function sayBonjour() { 
  2.  
  3.   alert(this.a) 
  4.  
  5.  
  6.   
  7.  
  8. obj.a = 1; 
  9.  
  10. obj.say = sayBonjour; 
  11.  
  12. obj.say();//1 
  13.  
  14. //or 
  15.  
  16. sayBonjour.call||apply(obj);//1  
  1. $('id').css({color:'red', fontSize:'12px', backgroundColor:'pink'}) 

nightmare:

  1. function error (a) { 
  2.  
  3.   if(typeof a !== 'string') { 
  4.  
  5.     console.error('param a must be type of string'
  6.  
  7.   } 
  8.  
  9.  
  10.   
  11.  
  12. function error() { 
  13.  
  14.   try { 
  15.  
  16.     // some code excucete here maybe throw wrong 
  17.  
  18.   }catch(ex) { 
  19.  
  20.     console.wran(ex); 
  21.  
  22.   } 
  23.  
  24.  

六、可预感性

可预感性味法度榜样接口供给结实性,为包管你的代码顺利履行,必须为它推敲到非正常预期的情况。我们看下弗成以预感的代码和可预感的代码的差别用之前的setColor

以上是zepto的源码,可以看见,作者在预感传入的参数时髦了很多的处理。其实可预感性是为法度榜样供给了若干的人口,无非是一些逻辑断定罢了。zepto在这里应用了很多的长短断定,同时导致了代码的冗长,不合适浏览。总之,可预感性真正须要你做的事多写一些对地位什物的参数。把外部的检测改为内部检测。是的应用的人用起来舒心宁神高兴。呐!做人嘛最重要的就是海森啦。

七、注释和文档的可读性

一个最好的接口是不须要文档我们也会应用它,然则往往接口量一多和营业增长,接口应用起来也话苄些费劲。所以接口文档和注释是须要卖力书写的。注释遵守简单扼要地原则,给多年后的本身也给后来者看:

  1. //注释接口,为了演示PPT用 
  2.  
  3. function commentary() { 
  4.  
  5.   //如不雅你定义一个没有字面意义的变量时,最好为它写上注释:a:没用的变量,可以删除 
  6.  
  7.   var a; 
  8.  
  9.   
  10.  
  11.   //在关键和有歧义的处所写上注释,如同画龙点睛:路由到hash界面后将所有的数据清空停止函数 
  12.  
  13.   return go.Navigate('hash'function(){ 
  14.  
  15.     data.clear(); 
  16.  
  17.   }); 
  18.  
  19.  

最后

【编辑推荐】

  1. JavaScript深刻之创建对象的多种方法以及优缺点

      推荐阅读

      智慧城市发展路径应分级分类

    智能泊车、长途智能抄表、智能路灯杆、智能井盖……聪明城市扶植正在为我们的生活带来各类便利。聪明城市也成为当前热议的话题。6月8日,第二十届中国北京国际科技家当博览会同>>>详细阅读


    本文标题:JavaScript的API设计原则

    地址:http://www.17bianji.com/lsqh/35828.html

关键词: 探索发现

乐购科技部分新闻及文章转载自互联网,供读者交流和学习,若有涉及作者版权等问题请及时与我们联系,以便更正、删除或按规定办理。感谢所有提供资讯的网站,欢迎各类媒体与乐购科技进行文章共享合作。

网友点评
自媒体专栏

评论

热度

精彩导读
栏目ID=71的表不存在(操作类型=0)