前端代码编码和设计规范系列——JavaScript编程规范
置顶 浪里沙 2016-07-15 15:43:19 3905 收藏 7
分类专栏： 规范文档 文章标签： javascript 设计规范 前端 文档
版权
规范文档
专栏收录该内容
0 篇文章0 订阅
订阅专栏
1文档信息
条目
内容
项目编号
通用
项目名称
通用
标题
JavaScript编程规范
类别
规范文档
当前
试用草稿
摘要
当前版本
V1.0
日期
2015/11/9
作者
徐维坚（xuweijian）
文档拥有者
内部公开
文件
前端规范系列-JavaScript篇.docx
2修改历史
编号
修订人
修订内容简述
修订
日期
修订前
版本号
修订后
版本号
V0001
徐维坚
编程规范文件编写，草稿试用版公布
2015/11/10
V1.0
规范前言
良好的编程规范对于软件的开发与维护，至关重要！他不仅可以提高代码的可读性、可靠性、有效性、健壮性，而且利于帮助开发人员开发和维护代码。对于一个团队协作的项目来说，人员的变动，一个良好的编程规范，有助于后续开发者和新手快速了解项目代码所要表现的含义。
1 范围
本规范规定了使用JavaScript语言编程时排版、命名、声明、作用域、及一些特殊符号的规则和建议。
本规范适用于使用JavaScript语言编程的产品和项目。
2 术语和定义
规则：编程时强制必须遵守的原则。
建议：编程时必须加以考虑的原则。
格式：对此规范格式的的说明。
说明：对此规范或建议进行必要的解释。
实例/如：对此规范或建议从正、反两个方面给出的例子。
1命名规范
1.1基本规则
规范的命名能使程序更易阅读，从而更易于理解。它们也可以提供一些标识功能方面的信息，有助于更好的理解代码和应用。
1） 规则一：使用可以准确说明变量、函数、原型(prototype)的完整英文描述符。严禁使用汉语拼音、不相关单词及汉字进行命名，实例：firstName，listAllUsers或 CorporateCustomer等；
2） 规则二：尽量少用缩写，但如果一定要使用或名称过长（不超过 25 个字母），当使用公共缩写和习惯缩写等，如实现（implement）可缩写成impl，经理（manager）可缩写成mgr等，严禁滥用缩写；
3） 规则三：变量命名必须以小写字母开头，命名使用骆峰命名规则；
4） 规则四：方法名必须使用动词或动词短语命名，实例：getIdcName()、export()等；
5） 规则五：避免使用相似或者仅在大小写上有区别的名字，以免不严格区分大小写的系统视为同一名称；
6） 规则六：避免命名中含有数字，但可以用2表示to，4表示for，另末尾使用数字表示同一系列的除外，如var$td_1 = $(‘.grid td’)[1];
7） 规则七：类名、构造函数、公共对象实例等名称首字母大写。
var MyCommon = {undefined
getSmallClassFromBigClass: function() {}
}
1.2相关建议
以下为相关建议，非必要遵循，但需要考虑
