Web前端工程师开发规范必须要注意的事(续)
JavaScript书写规范
-
文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || …);
-
库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;
-
变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;
jQuery变量要求首字符为’_’, 其他与原生JavaScript 规则相同, 如: _iTaoLun;
另, 要求变量集中声明, 避免全局变量.
-
类命名: 首字母大写, 驼峰式命名. 如 ITaoLun;
-
函数命名: 首字母小写驼峰式命名. 如iTaoLun();
-
命名语义化, 尽可能利用英文单词或其缩写;
-
尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval_r() & innerText;
-
后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;
-
代码结构明了, 加适量注释. 提高函数重用率;
-
注重与html分离, 减小reflow, 注重性能.
图片规范
-
所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;
-
图片格式仅限于gif || png || jpg;
-
命名全部用小写英文字母 || 数字 || _ 的组合,其中不得包含汉字 || 空格 || 特殊字符;尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;
-
在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;
-
尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);
-
运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.
注释规范
-
html注释: 注释格式 , ‘–’只能在注释的始末位置,不可置入注释文字区域;
-
css注释: 注释格式 ;
-
JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 ;
开发及测试工具约定
建议使用WebStorm||Aptana || Dw || Vim , 亦可根据自己喜好选择, 但须遵循如下原则:
-
不可利用IDE的视图模式’画’代码;
-
不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;
-
编码必须格式化, 比如缩进;
测试工具: 前期开发仅测试FireFox & IE6 & IE7 & IE8 & IE9 & Opera & Chrome & Safari;
其他规范
-
开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;
-
减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.