- 浏览: 7856530 次
- 性别:
- 来自: 广州
文章分类
- 全部博客 (2425)
- 软件工程 (75)
- JAVA相关 (662)
- ajax/web相关 (351)
- 数据库相关/oracle (218)
- PHP (147)
- UNIX/LINUX/FREEBSD/solaris (118)
- 音乐探讨 (1)
- 闲话 (11)
- 网络安全等 (21)
- .NET (153)
- ROR和GOG (10)
- [网站分类]4.其他技术区 (181)
- 算法等 (7)
- [随笔分类]SOA (8)
- 收藏区 (71)
- 金融证券 (4)
- [网站分类]5.企业信息化 (3)
- c&c++学习 (1)
- 读书区 (11)
- 其它 (10)
- 收藏夹 (1)
- 设计模式 (1)
- FLEX (14)
- Android (98)
- 软件工程心理学系列 (4)
- HTML5 (6)
- C/C++ (0)
- 数据结构 (0)
- 书评 (3)
- python (17)
- NOSQL (10)
- MYSQL (85)
- java之各类测试 (18)
- nodejs (1)
- JAVA (1)
- neo4j (3)
- VUE (4)
- docker相关 (1)
最新评论
-
xiaobadi:
jacky~~~~~~~~~
推荐两个不错的mybatis GUI生成工具 -
masuweng:
(转)JAVA获得机器码的实现 -
albert0707:
有些扩展名为null
java 7中可以判断文件的contenttype了 -
albert0707:
非常感谢!!!!!!!!!
java 7中可以判断文件的contenttype了 -
zhangle:
https://zhuban.me竹板共享 - 高效便捷的文档 ...
一个不错的网络白板工具
在多年开发邮箱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是弱语言造成的。在定义大量变量的时候,我们需要很明确的知道当前变量是什么属性,如果只通过普通单词,是很难区分的。
例如:
1
2
3
4
5
6
var group = [];
group.name = 'myGroup';
/****
some code
***/
//这时候你还能一眼就看出来group是什么吗?
又例如:
1
2
3
4
5
6
7
8
9
10
var checked = false;
var check = function(){
return true;
}
/**
some code
**/
if(check){//可能将checked写成check,由于不能很快速的发现check是函数,造成逻辑错误
//do some thing
}
如果我们写成:
1
2
3
4
5
6
7
8
9
10
11
12
13
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。常量可以存在于函数中,也可以存在于全局。
看个例子就 很容易明白为什么要这样定义了:
1
2
3
4
5
var userName = "dongua";
function checkName(userName){
//存在函数参数userName以及全局变量userName,如果要比较两个值是否相等,必需写为
return window.userName == userName
}
如果使用了全局变量的前缀,就十分清晰了。
2. 函数命名规范
统一使用动词或者动词[+名词]形式,例如:fGetVersion(),fSubmitForm(),fInit();涉及返回逻辑值的函数可以使用is,has等表示逻辑的词语代替动词。
如果有内部函数,使用__f+动词[+名词]形式,内部函数必需在函数最后定义。例如:
1
2
3
4
5
6
7
8
9
10
11
12
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。
总所周知,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是弱语言造成的。在定义大量变量的时候,我们需要很明确的知道当前变量是什么属性,如果只通过普通单词,是很难区分的。
例如:
1
2
3
4
5
6
var group = [];
group.name = 'myGroup';
/****
some code
***/
//这时候你还能一眼就看出来group是什么吗?
又例如:
1
2
3
4
5
6
7
8
9
10
var checked = false;
var check = function(){
return true;
}
/**
some code
**/
if(check){//可能将checked写成check,由于不能很快速的发现check是函数,造成逻辑错误
//do some thing
}
如果我们写成:
1
2
3
4
5
6
7
8
9
10
11
12
13
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。常量可以存在于函数中,也可以存在于全局。
看个例子就 很容易明白为什么要这样定义了:
1
2
3
4
5
var userName = "dongua";
function checkName(userName){
//存在函数参数userName以及全局变量userName,如果要比较两个值是否相等,必需写为
return window.userName == userName
}
如果使用了全局变量的前缀,就十分清晰了。
2. 函数命名规范
统一使用动词或者动词[+名词]形式,例如:fGetVersion(),fSubmitForm(),fInit();涉及返回逻辑值的函数可以使用is,has等表示逻辑的词语代替动词。
如果有内部函数,使用__f+动词[+名词]形式,内部函数必需在函数最后定义。例如:
1
2
3
4
5
6
7
8
9
10
11
12
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。
发表评论
-
微信开发工具中时间问题的小坑
2018-02-07 19:07 759刚开始用微信小程序开发工具,每次运行任何应用,都报这个错误: ... -
三篇不错的介绍CSS GRID的文章
2017-12-06 09:08 484三篇不错的介绍CSS GRID的文章: http://www. ... -
双因素认证(2FA)教程
2017-11-03 09:16 1463http://www.ruanyifeng.com/blog/ ... -
es6 中的export
2017-08-20 08:00 772https://juejin.im/post/5998625f ... -
markdown中的空格
2017-08-20 07:53 1654即使手动输入空格, 也是很不推荐的方法。我推荐全角空格,切换 ... -
(转)讲真,别再使用JWT了
2017-08-17 23:21 962不错的好文: http://insights.thoughtw ... -
(转)手把手教你WebStorm+chrome实现时时调试刷新
2017-08-15 10:50 2979参考: http://jingyan.baidu.com/ar ... -
IntelliJ Idea 2017 免费激活方法
2017-08-15 09:38 92661. 到网站 http://idea.lanyus.com/ ... -
前端框架这么多,该何去何从?
2017-08-04 07:17 603http://insights.thoughtworkers. ... -
记录一个HTML 5画拓扑图的商业公司
2017-07-18 19:56 811http://qunee.com/ DEMO:http:// ... -
vue 2例子学习收集
2017-07-16 11:46 9541 vue2.0手撸闲鱼App https://githu ... -
(收藏)虚拟DOM内部是如何工作的
2017-07-13 22:08 551虚拟DOM内部是如何工作的 https://segmentfa ... -
最近看到的几篇精彩JAVASCRIPT博客文章推荐
2017-07-11 07:10 525【深度长文】JavaScript数组所有API全解密 http ... -
jsonp 跨域原理:深入浅出 jsonp
2017-07-10 19:55 1386https://lzw.me/a/jsonp.html jso ... -
(转)深度长文-JavaScript数组所有API全解密
2017-07-08 19:59 780深度长文-JavaScript数组所有API全解密 http: ... -
(收藏)网页导出PDF的方案
2017-07-06 07:13 911(收藏)网页导出PDF的方案 https://yiqiwuli ... -
Chromium 新的弹窗机制以及 HTML 的 <dialog> 元素
2017-06-28 12:37 1113https://juejin.im/post/59525195 ... -
国内一个不错的大屏UI设计厂家
2017-06-03 19:43 3123http://www.lanlanwork.com/dp.ph ... -
canvas仿芝麻信用分仪表盘
2017-05-28 20:21 1525canvas仿芝麻信用分仪表盘 https://segment ... -
(转)CSS 变量教程
2017-05-10 21:12 527http://www.ruanyifeng.com/blog/ ...
相关推荐
Google JavaScript 编码规范指南 不解释
前端编码规范-JavaScript.pdf
web前端编码规范包括csst编码规范、htmlt编码规范、javascript编码规范。主要写了编码主要实现及编码经验和前端开发经验。
JavaScript程序编码规范.pdf 规范写入JavaScript!
好的规范,是团队协作的基石。JavaScript编码规范,让团队开发不再繁琐~~
前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, 工具, 框架, 资源 前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, 工具, 框架, 资源 前端学习笔记整理:HTML, CSS, JavaScript, Web 性能优化, ...
前端代码规范
头歌教学实践平台 Web前端开发基础 JavaScript学习手册十:正则表达式。源码txt格式。
Javascript编码规范,本文档主要的设计目标是商业体系前端Javascript开发风格保持一致,使容易被理解和被维护。
JavaScript编码规范_V1.00.doc
前端编码规范
资源名称:Javascript编码规范 资源截图: 资源太大,传百度网盘了,链接在附件中,有需要的同学自取。
JavaScript 程序编码规范,编程基本功。
javascript google 编码规范指南 中文版
javascript编码规范、HTML编码规范、CSS编码规范
整理前端开发的通常编码规范,包括CSS/JavaScript以及部分HTML编码规范。
本文档对javaScript编码进行了规范,有益提高开发人员的代码风格和能力。并且也可以做为团队的开发规范的统一和要求。
Google JavaScript编码规范指南是Google公司推出的一套详尽且实用的JavaScript编程规范,旨在为开发者提供一个清晰、一致的编码标准,以提高代码质量、可读性和可维护性。这套规范不仅涵盖了JavaScript语言的基础...