文档介绍：前端开发规范
总的来说,我们应该养成良好的JavaScript编码规范,这样有利于以后代码的维护、扩展。例如:出现人员流动的时候,新的开发人员也能快速的读懂代码,开展工作。
一、命名规范:
【说明】:类、方法、对象、变量、参数的命名(以下“他们”代表),从“他们”的字面意思都必须直接表达出“他们”所要表达的含义。所以,“他们”的命名必须用对应的英文单词命名(不能使用所写的英文单词),且第一个英文单词首字母小写,其它英文单词首字母大写,就是所谓的(骆驼命名法)。不过,为了更好的区分“他们”,我们可以在此命名的基础上,为“他们”各自增加一点不同的地方,用来区分“他们”。
1、类:
类其实是方法的一种转变。在类名称后面加上“Class”且第一个单词首字母大写,以此来标注类。如:var PersonClass:function(){};
2、DOM和jquery对象:
a、DOM对象:
·页面元素(htm),例如:var htmContainer;
·XML(xml),例如:var xmlControl;
b、jquery对象:
在DOM对象的基础上加上前缀“$”。
·页面元素jquery对象,例如:var $htmContainer;
·XML jquery对象,例如:var $xmlControl;
3、方法:
在方法名称的前面加上“_”下划线,以此来标注方法。如:_getName:function(){};
4、变量:
变量也可以分为许多种。如整数、小数、字符串、布尔、Object对象、数组等。命名规范如:
a、整数(int),例如:var intAge = 1;
b、小数(float),例如:var floatPrice = ;
c、字符串(string),例如:var stringName = 'pmxing';
d、布尔(bool),例如:var boolIsShow = true;
e、Object对象(object),例如:var objectPerson = {};
f、数组(array),例如:var arrayCars = new Array();
5、参数:
跟类|对象|方法|变量的命名一样,根据传的参数类型命名。
二、注释规范:
【说明】:javascript文件注释是为了描述文件内容,当然也可以注释版权、版本号以及修改时间(通用的用英文注释)。重要代码片段注释是非常有必要的,这样在原命名规范的基础上,让其他开发人员更容易读懂该代码片段所要实现的功能。
1、文件注释:
文件注释位于文件的最前面,应包括文件的以下信息:
a、概要说明及版本(必须)
b、版权声明(必须)
c、版本号(必须)
d、修改时间(必须)
e、项目地址(开源组件必须)
f、开源协议(开源组件必须)
文件注释必须全部以英文字符表示,并存在于文件的开发版本与生产版本中。例如:
/*!
* jRaiser 2 Javascript Library
* waterfall - (2013-03-15T14:55:51+0800)
* / | Released under MIT license
*/
/*!
* kan. - (2013-03-08T15:30:32+0800)
* Copyright 2005-2013
*/
如果文件内包含了一些开源组件,则必须在文件注释中进行说明。例如:
/*!
* jRaiser 2 Javascript Library
* sizzle - (2013-03-15T10:07:24+0800)
* / | Released under MIT license
*
* Include sizzle (/)
*/
2、普通注释:
普通注释是为了帮助开发者和阅读者更好地理解程序,不会出现在API文档中。其中,单行注释以“//”开头;多行注释以“/*”开头,以“*/”结束。
普通注释的使用需遵循以下规定。
a、总是在单行注释符后留一个空格。例如:
// this ment
b、总是在多行注释的结束符前留一个空格(使星号对齐)。例如:
/*
*/
c、不要把注释写在多行注释的开始符、结束符所在行。例如:
/* start
end */
d、不要编写无意义的注释。例如:
// 初始化value变量为0
var value = 0;
e、如果某段代码有功能未实现,或者有待完善,必须添加“TOD