鸦杀's Blog

JavaScript书写规范

2015-12-09

  1. 编码

统一为utf-8, 书写过程过, 每行代码结束必须有分号;

缩进为4个空格,不要使用Tab;

原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码、与现有代码冲突等);

后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;

  1. 库引入

原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;

  1. 变量命名

驼峰式命名。原生JavaScript变量要求是纯英文字母, 首字母须小写, 如myName;

jQuery变量要求首字符为“$”, 其他与原生JavaScript 规则相同, 如: $myName;

另, 要求变量集中声明, 避免全局变量。常量用 大写字母加下划线 如:MAX_COUNT。

  1. 类命名

首字母大写, 驼峰式命名. 如 ITaoLun;

  1. 函数命名

首字母小写驼峰式命名. 如iTaoLun();

  1. 命名语义化

尽可能利用英文单词或其缩写;

  1. 尽量避免使用存在兼容性及消耗资源的方法或属性

例如eval()/innerText;

  1. 基本书写方向

  2. 注重与HTML分离,减小reflow,注重性能;

  3. 代码结构明了, 加适量注释. 提高函数重用率;

扫描二维码,分享此文章