前端开发规范

Posted 2020-08-31 创业男生

前端开发规范

基本准则

符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.

文件规范

1、 html, css, js, images文件均归档至<系统开发规范>约定的目录中;

2、 html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;

3、 css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.;

4、 Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名.

html书写规范

1、 非特殊情况下样式文件必须外链至...之间;非特殊情况下javascript文件必须外链至页面底部;

2、引入样式文件或JavaScript文件时, 须略去默认类型声明,

3、 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js; 

4、语义化html, 如 标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;

5、书写链接地址时, 必须避免重定向，例如：href="http://itaolun.com/", 即须在URL地址后面加上“/”；

6、在页面中尽量避免使用style属性,即style="…";

7、能以背景形式呈现的图片, 尽量写入css样式中;

8、重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;

9、给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;

10、书写页面过程中, 请考虑向后扩展性;

css书写规范

1、编码统一为utf-8;

2、小图片（必须）sprite 合并

3、每个样式属性后加 ";"

4、优化css选择器

js书写规范

1、文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || ...);

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

3、变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun; jQuery变量要求首字符为‘_‘, 其他与原生JavaScript 规则相同, 如: _iTaoLun; 另, 要求变量集中声明, 避免全局变量.

4、类命名: 首字母大写, 驼峰式命名. 如 ITaoLun;

5、函数命名: 首字母小写驼峰式命名. 如iTaoLun();

6、命名语义化, 尽可能利用英文单词或其缩写;

7、尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval_r() & innerText;

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

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

10、注重与html分离, 减小reflow, 注重性能.

图片规范

1、所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;

2、图片格式仅限于gif || png || jpg;

3、命名全部用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;

4、在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;

5、尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);

6、运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下