目录
一、规范目的
为提高团队协作效率,便于前端后期优化维护,输出高质量的文档。
二、基本准则
- 符合web标准,结构表现行为分离,兼容性优良。页面性能方面,代码要求简洁明了有序, 尽可能的减小服务器负载,保证最快的解析速度。
- 项目的维护和二次开发可能是直接或间接的团队合作,所以创建易维护的代码是一个项目成功与否的关键,易维护的代码意味着具有如下特性:
- 阅读性好:如良好的注释和命名规范,有文档
- 具有一致性:看起来如同一个人编写
- 代码的松耦合,高度模块化:将页面内的元素视为一个个模块,相互独立,尽量避免耦合过高的代码,从html, css, js三个层面都要考虑模块化
- 严格按照规范编写代码
三、命名规范
1. 目的
提高代码可预测性和可维护性的方法是使用命名约定,这就意味着采用一致的方法来对变量和函数进行命名。
2. 变量名
变量名包括全局变量,局部变量,类变量,函数参数
3. 构造函数(类)命名
首字母大写,驼峰式命名。
JS中没有类,但是可以用new调用构造函数:var man = new Person();
4. 普通变量命名
首字母小写,驼峰式命名,匈牙利命名
如:nCheckCount 表示整形的数值
5. 匈牙利命名法
匈牙利命名法语法:变量名=类型+对象描述
类型指变量的类型
对象描述指对象名字全称或名字的一部分,要求有明确含义,命名要容易记忆容易理解。
提示: 虽然JavaScript变量表面上没有类型,但是JavaScript内部还是会为变量赋予相应的类型
JavaScript变量起名类型 | 变量命名前缀 | 举例 |
---|---|---|
Array 数组 | a | aList,aGroup |
Boolean 逻辑 | b | bChecked, bHasLogin |
Function 函数 | f | fGetHtml, fInit |
Integer 数字 | n | nPage, nTotal |
Object 对象 | o | oButton, oDate |
Regular Expression 正则 | r | rDomain, rEmail |
String 字符 | s | sName, sHtml |
6. 例外情况
以根据项目及团队需要,设计出针对项目需要的前缀规范,从而达到团队开发协作便利的目的。