收藏 分享(赏)

web前端开发规范及要求.docx

上传人:HR专家 文档编号:6634874 上传时间:2019-04-19 格式:DOCX 页数:3 大小:35.85KB
下载 相关 举报
web前端开发规范及要求.docx_第1页
第1页 / 共3页
web前端开发规范及要求.docx_第2页
第2页 / 共3页
web前端开发规范及要求.docx_第3页
第3页 / 共3页
亲,该文档总共3页,全部预览完了,如果喜欢就下载吧!
资源描述

1、Web 前端开发规范1. 规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发 . 本文档如有不对或者不合适的地方请及时提出.2. 基本准则符合 web 标准, 语义化 html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度。至少兼容: FireFox 4. Js 文件命名: 英文命名, 后缀.js. 共用 common.js, 其他依实际模块需求命名.4. html 书写规范1. 编码统一为 ut

2、f-82. 引入 JS 库文件 , 文件名须包含库名称及版本号及是否为压缩版 , 比如 jquery-1.7.1.min.js3. 所有编码均遵循 xhtml 标准, 标签 属性值必须用双引号包括4. 充分利用无兼容性问题的 html 自身标签, 比如 span, em, strong, optgroup, label,等等; 需要为 html 元素添加自定义属性的时候 , 首先要考虑下有没有默认的已有的合适标签去设置 , 如果没有, 可以使用须以”data-” 为前缀来添加自定义属性,避免使用”data:” 等其他命名方式5. 语义化 html, 如 标题根据重要性用 h(同一页面只能有一个

3、 h1), 段落标记用 p, 列表用 ul, 内联元素中不可嵌套块级元素6. 尽可能减少 div 嵌套7. 在页面中尽量避免使用 style 属性,即 style=”;8. 能以背景形式呈现的图片, 尽量写入 css 样式中;9. 重要图片必须加上 alt 属性; 给重要的元素和截断的元素加上 title;10. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;11. 书写页面过程中, 请考虑向后扩展性;12. class ”代替原来的“#”标记5. css 书写规范1. 编码统一为 utf-8;2. 协作开发及分工: i 会根据各个模块, 同时根据页面相似程序, 事先写好大体框

4、架文件, 分配给前端人员实现内部结构 共用 css 文件 base.css 由 i 书写 , 协作开发过程中 , 每个页面请务必都要引入, 此文件包含 reset 及头部底部样式 , 此文件不可随意修改;3. class 与 id 的使用: id 是唯一的并是父级的, class 是可以重复的并是子级的, 所以 id 仅使用在大的模块上, class 可用在重复使用率高及子级中.4. class 与 id 命名 : 大的框架命名比如 header/footer/wrapper/left/right 之类的在 2 中由 i 统一命名. 其他样式名称由 小写英文 避免使用中文拼音, 尽量使用简易的

5、单词组合 ; 总之, 命名要语义化, 简明化.5. css 属性书写顺序, 建议遵循: 布局定位属性自身属性 文本属性 其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起 . 6. 书写代码前, 考虑并提高样式重复使用率;7. 充分利用 html 自身属性及样式继承原理减少代码量 .8. 背景图片请尽可能使用 sprite 技术, 减小 http 请求, 考虑到多人协作开发, sprite 按模块制作;9. 尽量少使用兼容 hack。10. 避免兼容性属性的使用, 比如 text-shadow | css3 的相关属性;11. 必须为大区块样式添加注释, 小区块适量注释;12.

6、杜绝使用 兼容 ie8;13不同浏览器上字号保持一致,字号建议像素 px 来定义。6. JavaScript 书写规范1. 文件编码统一为 utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据 XXX 项目需求原生开发, 以避免网上 down 下来的代码造成的代码污染(沉冗代码 | 与现有代码冲突 | );2. 库引入: 原则上仅引入 jQuery 库, 若需引入第三方库, 须提供相关说明文档(库名 | 版本 | 使用说明 );3. 变量命名: 驼峰式命名. 原生 JavaScript 变量要求是纯英文字母, 首字母须小写, 如 iTaoLun;4. 类命名: 首字母大写

7、, 驼峰式命名. 如 ITaoLun;5. 函数命名: 首字母小写驼峰式命名. 如 iTaoLun();6. 命名语义化, 尽可能利用英文单词或其缩写;7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如 eval() 8. 代码结构明了, 加适量注释. 提高函数重用率;9. 注重与 html 分离, 减小 reflow, 注重性能.7. 图片规范1. 图片格式仅限于 gif | png | jpg;2. 命名全部用小写英文字母 | 数字 | _ 的组合,其中不得包含汉字 | 空格 | 特殊字符;尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如

8、ad_left01.gif | btn_submit.gif;3. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;4. 尽量避免使用半透明的 png 图片5. 运用 css sprite 技术集中小的背景图或图标 , 减小页面 http 请求, 但注意, 请务必在对应的sprite psd 源图中划参考线8. 开发及测试工具约定开发工具可自行选择,但须遵循如下原则:1. 不可利用 IDE 的视图模式画代码;2. 不可利用 IDE 生成相关功能代码, 比如 Dw 内置的一些功能 js;3. 编码必须格式化, 比如缩进;测试工具: 前期开发仅测试 FireFox 2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德 . 为用户着想, 为服务器着想.

展开阅读全文
相关资源
猜你喜欢
相关搜索
资源标签

当前位置:首页 > 企业管理 > 管理学资料

本站链接:文库   一言   我酷   合作


客服QQ:2549714901微博号:道客多多官方知乎号:道客多多

经营许可证编号: 粤ICP备2021046453号世界地图

道客多多©版权所有2020-2025营业执照举报