`
Seven7+
  • 浏览: 32455 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

网易邮箱前端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';
 /**** some code ***///这时候你还能一眼就看出来group是什么吗?

又例如:

var checked = false; 
var check = function(){    
 return true;
 } 
/** some code **
/if(check){//可能将checked写成check,由于不能很快速的发现check是函数,造成逻辑错误     //do some thing 
} 


如果我们写成:

var bChecked = false; 
var fCheck = function(){    
 return true;
 }
 /** some code **/
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(),fAddressSubmitButtonClick()

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<m;i++){ do something}。

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

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

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

分享到:
评论

相关推荐

    Vue前端编码规范.pdf

    ### Vue前端编码规范详解 #### 一、概述 在现代前端开发中,特别是使用Vue框架进行项目构建时,遵循一套合理的编码规范对于提高代码质量、维护性和团队协作效率至关重要。本文将详细介绍Vue前端项目的编码规范,...

    前端js代码规范

    本文将详细介绍北京道达天际科技有限公司的一套JavaScript编码规范,该规范涵盖了代码风格、命名规则、注释习惯以及语言特性的最佳实践。 #### 二、代码风格 **2.1 文件** - **UTF-8编码:** 建议使用无BOM的UTF-8...

    JavaScript编码规范

    ### JavaScript编码规范详解 #### 1. 前言 随着JavaScript在前端开发中的广泛应用,尤其是在浏览器端的行为管理方面,确保代码风格的一致性对于提高团队协作效率至关重要。本篇文章旨在提供一套统一的JavaScript...

    前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, 工具, 框架, 资源.zip

    前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, 工具, 框架, 资源 前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, 工具, 框架, 资源 前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, ...

    WEB前端编码规范WEB前端编码规范WEB前端编码规范

    WEB前端编码规范是确保开发团队在进行网页及应用开发时保持一致性和可维护性的关键指导文档。这份规范由中兴通讯股份有限公司制定,旨在提升代码质量、增强跨浏览器兼容性,以及实现WEB前端的结构、样式与行为的分离...

    web安全前端编码规范1

    《Web安全前端编码规范详解》 在Web应用开发中,前端的安全性同样至关重要。本文将详细阐述《Web安全前端编码规范》,旨在提升Web应用的安全性,预防潜在的攻击风险。 一、项目设计阶段的安全考虑 在项目初始设计...

    Google_JavaScript_编码规范指南

    总结来说,Google的JavaScript编码规范指南为开发者提供了一套标准化的编码实践建议,涵盖了从基础的语法到高级编码技术的方方面面。遵循这些规范不仅可以提升代码质量,还能帮助维护项目的一致性和可扩展性。

    前端团队管理 前端基础架构的实践和思考 共22页.pdf

    * 融入到整个技术体系中:前端基础架构需要具备融入到整个技术体系中的特点,能够与后端技术无缝结合,发挥技术最大能量。 前端基础架构的组成部分: * 代码风格Guidelines * 性能/可用性/可访问性技术文档 * 培训...

    前端编码规范(3)JavaScript 开发规范

    JavaScript 开发规范是前端开发中的重要组成部分,旨在提高代码质量、可读性和可维护性。以下是一些关键的JavaScript编码规范: 1. **变量声明**: - 总是使用 `var`、`let` 或 `const` 来声明变量。不指定变量...

    JavaScript 程序编码规范

    JavaScript程序编码规范是编程的基本功,它涉及到代码的可读性、可维护性和团队协作效率。遵循一套良好的编码规范能够使代码更具一致性,减少错误,提高代码质量。以下是一些关键的JavaScript编码规范要点: 1. **...

    Google JavaScript 编码规范

    Google的JavaScript编码规范是一个被广泛接受和推荐的编码标准,它详细规定了如何编写易于理解和维护的JavaScript代码。下面,我们将详细探讨这一规范中包含的关键知识点。 **JavaScript语言规范:** 1. **变量...

    JavaScript 程序编码规范(pdf).rar

    JavaScript是一种广泛应用于Web开发的脚本语言,它在前端交互、后端开发以及移动应用等领域都有广泛应用。良好的编码规范对于任何编程语言来说都是至关重要的,因为它可以提高代码的可读性、可维护性和团队协作效率...

    头歌教学实践平台 Web前端开发基础 JavaScript学习手册九:字符串

    JavaScript是Web前端开发的核心语言之一,它在网页交互、数据处理和动态效果实现等方面发挥着重要作用。本手册将深入探讨JavaScript中的字符串,这是编程中常用的数据类型,对于理解和操作文本至关重要。 一、字符...

    Javascript编码规范

    ### JavaScript编码规范详解 #### 一、引言 随着Web技术的发展,JavaScript作为一种重要的前端脚本语言,在网页交互设计和动态效果实现上扮演着至关重要的角色。然而,由于JavaScript语言本身的特性,例如语法较为...

    Web前端编码规范

    ### Web前端编码规范知识点 #### JavaScript编码规范 1. **JS文件组织**: - 所有的JavaScript代码应当被组织在单独的`.js`文件中,并通过`&lt;script type="text/javascript" src="xxx.js"&gt;&lt;/script&gt;`的方式在HTML...

    阿里前端开发规范.pdf

    在编写阿里前端开发规范文档的过程中,涉及到了前端开发的多个重要方面,包括编程规约、HTML规范、CSS规范、LESS规范、Javascript规范以及Vue项目规范。以下是这些规范的详细知识点: 一、编程规约 命名规范是编程...

    前端编码规范

    前端编码规范是指在前端开发过程中,为了确保代码的可读性、可维护性、一致性和性能等方面,而制定的一系列编码规则和约定。本规范涵盖了HTML、CSS以及JavaScript这三大前端技术栈,强调了编码时应该遵循的一些基本...

    JavaScript语言教程:基础语法、DOM操作、事件处理及新特性详解

    从JavaScript的基本概念出发,详尽讲解了基础语法(如变量、数据类型、运算符、流程控制)、函数和闭包、对象和原型、DOM操作(如获取、修改、添加和删除元素)、事件处理(如事件监听器、事件对象)、AJAX与Fetch ...

    JAVA及前端开发编码规范.zip

    总的来说,这些编码规范不仅是编写高质量代码的基础,也是团队成员间沟通的桥梁。遵循这些规范,可以使代码更具一致性,减少误解,提高开发效率。在实际项目中,开发者还应根据项目特性和团队需求,灵活调整和扩展...

    Javascript编码规范.docx

    在编写JavaScript代码时,遵循一定的编码规范是非常重要的,它有助于提高代码...以上就是从给定的文件内容中提炼出的JavaScript编码规范的一些核心要点,它们对于任何JavaScript开发人员来说都是非常基础且重要的实践。

Global site tag (gtag.js) - Google Analytics