web前端开发规范及要求

1、Web前端开发规范 1. 规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出.2. 基本准则符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度。至少兼容：FireFox & IE7 & IE8 & IE9& IE10 & IE11 & Chrome。3. 文件规范1. 文件命名规则：文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符。2. html文件命名: 英文命名，后缀.html。各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。如：首页index；关于我们aboutus3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.;4. Js文件命名: 英文命名, 后缀.js. 共用common.js,

2、其他依实际模块需求命名.4. html书写规范1. 编码统一为utf-82. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.7.1.min.js3. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合; 属性值必须用双引号包括4. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性，避免使用”data:”等其他命名方式5. 语义化html, 如 标题根据重要性用h(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素6. 尽可能减少div嵌套7. 在页面中尽量避免使用style属性,即style=”;8. 能以背景形式呈现的图片, 尽量写入css样式中;9. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;10.

3、给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;11. 书写页面过程中, 请考虑向后扩展性;12. class & id 参见 css书写规范.13. 页面中尽量不要写入JavaScript代码，尽量使用外部文件引用14. 为了最大程度的发挥浏览器自动排版的功能，在一段完整的文字中请尽量不要使用来人工干预分段。15. 在浏览器里，当我们点击空链接时，它会自动将当前页面重置到首端，从而影响用户正常的阅读内容，我们用代码“javascript:void(0);”代替原来的“#”标记5. css书写规范1. 编码统一为utf-8;2. 协作开发及分工: i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件base.css由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改;3. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中.4. class

4、与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由 小写英文 & 数字 & _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.5. css属性书写顺序, 建议遵循: 布局定位属性自身属性文本属性其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起.6. 书写代码前, 考虑并提高样式重复使用率;7. 充分利用html自身属性及样式继承原理减少代码量.8. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;9. 尽量少使用兼容hack。10. 避免兼容性属性的使用, 比如text-shadow | css3的相关属性;11. 必须为大区块样式添加注释, 小区块适量注释;12. 杜绝使用兼容ie8;13不同浏览器上字号保持一致，字号建议像素px来定义。6. JavaScript书写规范1. 文件编码统一为utf-8, 书写过程过, 每行

5、代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 | 与现有代码冲突 | );2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须提供相关说明文档（库名 | 版本 | 使用说明）;3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;4. 类命名: 首字母大写,驼峰式命名. 如 ITaoLun;5. 函数命名: 首字母小写驼峰式命名. 如iTaoLun();6. 命名语义化, 尽可能利用英文单词或其缩写;7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;8. 代码结构明了, 加适量注释. 提高函数重用率;9. 注重与html分离, 减小reflow, 注重性能.7. 图片规范1. 图片格式仅限于gif | png | jpg;2. 命名全部用小写英文字母 | 数字 | _ 的组合，其中不得包含汉字 | 空格 | 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif | btn_submit.gif;3. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;4. 尽量避免使用半透明的png图片5. 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线8. 开发及测试工具约定开发工具可自行选择，但须遵循如下原则:1. 不可利用IDE的视图模式画代码;2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;3. 编码必须格式化, 比如缩进;测试工具: 前期开发仅测试FireFox & IE7 & IE8 & IE9 & Chrome9.其他规范1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.

《web前端开发规范及要求》由会员小**分享，可在线阅读，更多相关《web前端开发规范及要求》请在金锄头文库上搜索。