前端开发规范

文件规范

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

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

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

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

html书写规范

1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为utf-8, 书写时利用IDE实现层次分明的缩进;

2. 非特殊情况下样式文件必须外链;非特殊情况下JavaScript文件必须外链至页面底部;

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

4. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等不要总频繁使用空div。

5. 语义化html,头部header尾部footer文档区域section等。

6. 尽可能减少div嵌套。

7. 在页面中尽量避免使用行内样式。

8. 必须为含有描述性表单元素(input, textarea)添加label。

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

10. 给区块代码及重要功能(比如循环)加上注释, 方便后台阅读。

css书写规范

1. 编码统一为utf-8;

2. 编写公用模块css文件,主要包括reset部分和公用模块css,提高代码重用率。

3.注意css和id的使用样式部分大部分重用率高的用class,id主要用于标识大的区域和js的使用。

4. 为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show。

5. 背景图片请尽可能使用sprite技术, 减小http请求。

6. 减少使用影响性能的属性, 比如position:absolute || float ;

7. 必须为大区块样式添加注释, 小区块适量注释;

JavaScript书写规范

1. 文件编码统一为utf-8,。

2. 驼峰式命名,命名语义化。

3. 原则上要求原生开发。

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

5. 注重与html分离, 减小reflow, 注重性能。

注释规范

1. html注释: 注释格式 , ’–’只能在注释的始末位置,不可置入注释文字区域;

2. css注释: 注释格式 /*这儿是注释*/;

3. JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 /* 这儿有多行注释 */;

你可能感兴趣的:(前端开发规范)