开发者社区> suboysugar> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

网易前端JavaScript编码规范

简介: 在多年开发邮箱webmail过程中,网易邮箱前端团队积累了不少心得体会,我们开发了很多基础js库,实现了大量前端效果组件,开发了成熟的opoa框架以及api组件,在此向大家做一些分享。今天想先和大家聊聊javascript的编码规范。
+关注继续查看

 在多年开发邮箱webmail过程中,网易邮箱前端团队积累了不少心得体会,我们开发了很多基础js库,实现了大量前端效果组件,开发了成熟的opoa框架以及api组件,在此向大家做一些分享。今天想先和大家聊聊javascript的编码规范。

  总所周知,javascript是一种语法极其灵活的语言。javascript在设计之初就只是用来为HTML添加动态效果的。由于他动态,弱类型 等特性,以及不同浏览器的兼容性问题,造成了开发成本要比java等语言要高很多。正因为它太灵活,我们制定了适用于网易邮箱的javascript编码 规范,尽可能多的降低由于语法灵活造成的问题。以下将具体介绍:

  1. 变量命名规范

  变量名包括全局变量,局部变量,类变量,函数参数等等,他们都属于这一类。

  基本规范

  变量命名都以类型前缀+有意义的单词组成,单词首字母都需要大写。例如:sUserName,nCount。

  前缀规范

  每个局部变量都需要有一个类型前缀,按照类型可以分为:

  s:表示字符串。例如:sName,sHtml;

  n:表示数字。例如:nPage,nTotal;

  b:表示逻辑。例如:bChecked,bHasLogin;

  a:表示数组。例如:aList,aGroup;

  r:表示正则表达式。例如:rDomain,rEmail;

  f:表示函数。例如:fGetHtml,fInit;

  o:表示以上未涉及到的其他对象,例如:oButton,oDate;

  例外情况:

  1:作用域不大临时变量可以简写,比如:str,num,bol,obj,fun,arr。

  2:循环变量可以简写,比如:i,j,k等。

  为什么需要这样强制定义变量前缀?正式因为javascript是弱语言造成的。在定义大量变量的时候,我们需要很明确的知道当前变量是什么属性,如果只通过普通单词,是很难区分的。

 

  例如:

var group = [];    
group.name = 'myGroup';    

//这时候你还能一眼就看出来group是什么吗?

 

  又例如:

var checked = false;    
var check = function(){    
       return true;    
}    

if(check){//可能将checked写成check,由于不能很快速的发现check是函数,造成逻辑错误    
       //do some thing    
}

 

  如果我们写成:

var bChecked = false;    
var fCheck = function(){    
       return true;    
}    

if(bChecked){    
       // do some thing    
}    
if(fCheck()){    
       // do other thing    
}

 

  就清楚很多了。

  全局变量以及常量规范

  网易邮箱前端是基于“类”的概念来来开发javascript的(稍后会专门介绍),每个类定义都是在一个闭包函数中,除了在window下有类的定义而外,只允许有两种变量定义在全局,那就是全局变量和常量。

  全局变量使用g作为前缀,定义在window下。例如gUserName,gLoginTime。

  某些作为不允许修改值的变量认为是常量,全部字母都大写。例如:COPYRIGHT,PI。常量可以存在于函数中,也可以存在于全局。

  看个例子就 很容易明白为什么要这样定义了:

var userName = "dongua";    
function checkName(userName){    
       //存在函数参数userName以及全局变量userName,如果要比较两个值是否相等,必需写为    
       return window.userName == userName    
}

 

  如果使用了全局变量的前缀,就十分清晰了。

  2. 函数命名规范

  统一使用动词或者动词[+名词]形式,例如:fGetVersion(),fSubmitForm(),fInit();涉及返回逻辑值的函数可以使用is,has等表示逻辑的词语代替动词。

  如果有内部函数,使用__f+动词[+名词]形式,内部函数必需在函数最后定义。例如:

function fGetNumber(nTotal){    
       if(nTotal<100){    
   nTotal = 100;    
     }    
  return __fAdd(nTotal);        
      
  function __fAdd(nNumber){    
   nNumber++;    
   return nNumber;    
  }    
}    
alert(fGetNumber(30));//alert 101

 

  对象方法实现

  对象方法命名使用 f+对象类名+动词[+名词]形式;例如 fAddressGetEmail

  事件响应函数

  某事件响应函数命名方式为触发事件对象名+事件名或者模块名+触发事件对象名+事件名,例如:fDivClick(),fAddressSubmitButtonClic k()

  3.其他注意事项

  1:所有命名最好使用英语表示。

  2:所有变量名应该明确而必要,尽量避免不必要的容易混淆的缩写。

  3:netease.events.mouse.Handler,而不是 netease.events.mouse.MouseEventHandler。

  4:对应的方法应该使用对应的动词,例如:get/set, add/remove, create/destroy, start/stop, insert/delete, begin/end。

  5:应该避免双重否定意义的变量,例如:bIsNotError, bIsNotFound,不可取。

  6:变量应该在最小的范围内定义,并尽可能的保持最少的活动时间。

  7:循环变量最好在循环中定义。例如for(var i=0,m=10;i

  8:尽量避免复杂的条件语句,可以使用临时的boolean变量代替。

  9:一定要避免在条件中执行语句,例如:if((i=3)>2){},不可取。

  10:不要在代码中重复使用相同意义的数字,用一个变量代替,比如 nTotal=100; num= total。

 

  网易邮箱页面在window只允许定义三种变量——1:全局变量;2:常量;3:类。任何业务逻辑都需要通过类方法或者示例方法实现。前两种变量在之前文章中已经介绍,在此不再累述,接下来详细介绍类定义和使用的规范。

  定义类是通过一个闭包完成的:

(function(){    
   //第一步:引入存在的类。引入support类    
   var Support = window.Support;      
      
   //$是网易邮箱基础库“base”的引用稍后会介绍    
   //第二步:定义类。可以认为返回了一个类定义 function(){},并在window下定义一个Image类    
   var Image = $.createClass("Image");      
      
   //可以认为是jQuery的extend方法      
      
   //第三步:定义类属性/方法定义    
   $.Object.extend(Image,{    
     _language : null,     //内部属性    
     getSize   : fImageGetSize    
   });    
   //第四步:定义实例属性/方法定义    
   $.Object.extend(Image.prototype,{    
     name   : null,    
     url     : null,    
     ext     : null,    
     width   : 0,    
     height   : 0,    
     setName   : fImageSetName,    
     getName   : fImageGetName,    
     init   : fImageInit    
   });    
   //第五步:方法实现      
      
   function fImageGetSize(nWidth,nHeight){    
     return nWidth*nHeight;    
   }      
      
   function fImageSetName(sName){    
     var oImage = this;    
     oImage.name = sName;    
   }      
      
   function fImageGetName(){    
     var oImage = this;    
     return oImage.name;    
   }      
      
   function fImageInit(sUrl){    
     var oImage = this;    
     oImage.url = sUrl;    
     oImage.ext = Support.getExt(sUrl);    
     oImage.width = Support.getWidth(sUrl);    
     oImage.height = Support.getHeight(sUrl);    
   }      
      
  })();

 

  我们可以看到,这个闭包完成了以下几件事情:

  1.引入这个类需要用到的其他类。

  2.定义这个类。

  3.定义类的属性和方法。

  4.定义类的实例属性和方法。

  5.类和实例方法的实现。

  在命名上,我们遵循了一下规则:

  1.类名首个字母必需大写,例如Image,Support等。

  2.属性名需要是有意义的名词,首字母小写,例如oImage.width。

  3.方法名需要是有意义的动词[+名词],首字母小写,例如Support.getWidth

  4.如果不希望被其他方法调用,需要在属性或者方法名前面加“_”,例如oImage._language

  5.如果不希望被子类调用,需要在属性或者方法名前加“_”,例如oImage.__fire()

  这里需要特别说明以下几点:

  1.方法的定义不是通过匿名函数来定义,而是集中在类定义的下面来实现。这样的好处是能在最开始将类的属性方法定义都罗列出来,便于通过源码查看到对应属性和方法。

  2.在类/实例方法中,使用局部变量代替this。this不是一个好的玩意儿,一不小心就会被this搞晕。使用局部变量能够尽量避免这样的问题,也能够在压缩混淆的时候效果更好。

  3.在实际开发过程中,每个类定义都单独一个js实现。

  除了类的定义,闭包不实现 任何其他逻辑。使用闭包能够将很多变量约束在闭包作用域中,并且能够在压缩混淆中效果更好,除此之外,使用闭包定义类,在之后将介绍到的动态加载成为了一件十分容易的事情,稍后会和大家一起分享。

如何联系我:【万里虎】www.bravetiger.cn 【QQ】3396726884 (咨询问题100元起,帮助解决问题500元起) 【博客】http://www.cnblogs.com/kenshinobiy/

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
JavaScript 编码风格指南
写作本文旨在加深自己印象,也为了更多人的了解到JS编码风格,提高自己的编码质量想了解更多的内容请阅读《编写可维护的JavaScript》 缩进 每一行的层级由4个空格组成,避免使用制表符 (Tab) 进行缩进 // 好的写法 if (true) { doSomething(); } 行的长度 每行长度不应超过80个字符。
871 0
JavaScript编码风格指南
程序语言的编码风格指南对于一个长期维护的软件而言是非常重要的;好的编程风格有助于写出质量更高、错误更少、更易于 维护的程序。 团队合作需要制定一些代码规范还有利用一些工具来强制要求团队代码的风格统一.毕竟很多情况下以后不一定是由写一手代码的人来维护代码,所以有一个统一的代码风格很重要!!!
744 0
原生js实现无限循环上下滚动公告
       说到滚动,想到的应该就是跑马灯效果。当然在网上有很多种实现方式,今天就用原生js来实现一个简单的上下无限循环滚动公告吧,代码不多,而且容易理解。
3617 0
JS端自己拼接一个表单进行提交:实现下载或者传参后台
JS端自己拼接一个表单进行提交:实现下载或者传参后台
1736 0
中高级前端应该必会,js实现事件委托代理、切换样式、元素获取相对于文档位置等
1、介绍   随着组件开发大流行,现在三大框架已经基本占领了整个前端。   这时候,我们要是引入一个 jq 是不是先得你的项目非常臃肿,jq 也很不适合。   这个时候,你就需要来增加你 js 的功底。
1331 0
java、js实现百度坐标(BD09)、国测局坐标(火星坐标,GCJ02)、和WGS84坐标系之间的转换
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/gisdoer/article/details/82684617 java、js实现...
2634 0
js 最简单的实现复制到剪切板 xl_copy
使用   npm install xl_copy // 项目中安装 import clipboard form 'xl_copy' // 引用 element.onclick = ()=>{     clipboard('test')  // 复制 test }   1、介绍     利用原生...
1191 0
两种使用原生js实现导出excel数据简单讲解
1.js导出csv 简单来说csv就是一种数据以逗号隔开的,文件以纯文本形式存储表格数据。csv优点是实现起来相对简单,但是不支持多sheet和样式 具体可以查看CSV百度百科进行了解 根据csv格式的说明,所以我们实现导出csv就很简单了,只要原始数据转换成列数据与列数据之间用逗号隔开,行数据进行换行格式的文本数据其后缀为 .
1506 0
JS实现抽奖(方形)
展示: HTML: 1 2 3 顺序抽/停止 4 随机抽/停止 5 CSS: 1 table { 2 text-align: center; 3 border-collapse: ...
1174 0
使用js实现二级联动表
我们在做项目的时候,经常会遇到选择省市级、选择单位部门等功能,也就是我们熟悉的二级联动问题。 之前没有接触过二级联动,所以感觉二级联动会比较麻烦,实现起来很困难。
1137 0
+关注
suboysugar
目前为自由职业者,从事BA业务分析和互联网产品设计等工作,本人先后在中关村在线、中国工商银行和神州数码工作。拥有互联网,移动互联网,软件公司等开发经历。计算机本科毕业,8年互联网和软件行业经验。
710
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载