5.1 JavaScript书写规范
2018-09-10 本文已影响0人
爱聊天助手
- 书写过程中, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || ...);
- 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;
- 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如taoLun; jQuery变量要求首字符为'_', 其他与原生JavaScript 规则相同, 如: _taoLun; 另, 要求变量集中声明, 避免全局变量;
- 类命名: 首字母大写, 驼峰式命名. 如 TaoLun;
- 函数命名: 首字母小写驼峰式命名. 如 taoLun();
- 命名语义化, 尽可能利用英文单词或其缩写;
- 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;
- 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;
- 代码结构明了, 加适量注释. 提高函数复用率;
- 注重与html分离, 减小reflow, 注重性能。