1 / 16
文档名称:

web前端规范.docx

格式:docx   大小:48KB   页数:16页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

web前端规范.docx

上传人:w447750 2017/10/7 文件大小:48 KB

下载得到文件列表

web前端规范.docx

相关文档

文档介绍

文档介绍:Web前端开发规范
规范目的
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改。
基本准则
符合web标准, 语义化html, 结构表现行为分离, 兼容性优良。页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度。
文件规范
1. html, css, js, images文件均归档至团队的<系统开发规范>约定的目录中;
2. html文件命名: 英文命名, . 或者html同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;
3. css文件命名: 英文命名, . , , 其他页面依实际模块需求命名.;
4. Js文件命名: 英文命名, . , 其他依实际模块需求命名.
html书写规范
 文档类型声明及编码: 统一为html5声明类型<!DOCTYPE html>; 编码统一为<meta charset=”utf-8″ />, 书写时利用Tab键(敲两个空格)
实现层次分明的缩进(具体情况视开发环境而定);
2. 注意文件的引用顺序,库文件必须放在前面,非特殊情况下样式文件必须外链至<head>…</head>之间;非特殊情况下JavaScript文件必须外链至页面底部;
3. 引入样式文件或JavaScript文件时, 不要略去默认类型声明, 写法如下:
<link rel=”stylesheet” type=”text/css” href=”…” />
<style type=”text/css”>…</style>
<script type="text/javascript" src=”…”></script>
4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-; 引入插件, 文件名格式为库名称+插件名称, ;
5. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (<br />), hr(<hr />)等; 属性值必须用双引号包括;
6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等;
7. 语义化html, 如标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul,ol, 内联元素中一般情况下不可嵌套块级元素;
8. 
9. 书写链接地址时, 必须避免重定向,例如:href=”/”, 即须在URL地址后面加上“/”;
10. 在html页面中尽量避免使用style属性,即style=”…”;( 这样做的目的性是为了方便后期代码的维护)
11. 必须为含有描述性表单元素(input, textarea)添加label, 如<p>姓名: <input type=”text” id=”name” name=”name” /></p>须写成:<p><label for=”name”>姓名: </label><input type=”text” id=”name” /></p>
label的for属性值要和input 的id属性值一样。还有一种写法:如果把input标签写在label中则可以省略for属性
12. 能以背景形式呈现的图片, 尽量写入css样式中;
分两种情况:一是不变的图片背景,二是不断变化的图片背景。不变的可以写在css中,但是如果背景是需要不断地变化的,就不能写在css文件中了,因为这样后台人员无法方便的动态设置背景图片
13. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;
14. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;
15. 特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(>) & 空格( ) & »(») 等等;
16. class & id 参见 css书写规范.
css书写规范
1. 编码统一为utf-8;
2. 协作开发及分工: i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构,表现,行为; 共用css