文豆Web前端开发规范手册V12.docxVIP

文豆Web前端规范手册V1.2 PAGE PAGE 9 文豆Web前端开发规范手册 更新记录 版本号 日期 更新内容 修订 V1.0 2010-05-01 创建文档 宋敏鹏 V1.1 2011-02-01 修改细节 宋敏鹏 V1.2 2015-05-28 修改细节 宋敏鹏 文豆 TOC \o 1-3 Web前端开发规范手册 1、规范目的 PAGEREF _Toc295496618 \h 3 2、基本准则 PAGEREF _Toc295496619 \h 3 3、文件规范 PAGEREF _Toc295496620 \h 3 3.1 目录结构 PAGEREF _Toc295496621 \h 3 3.2 html 文件命名 PAGEREF _Toc295496622 \h 4 3.3 css 文件命名 PAGEREF _Toc295496623 \h 4 3.4 js文件命名 PAGEREF _Toc295496624 \h 4 4、html 书写规范 PAGEREF _Toc295496625 \h 4 4.1 编码 PAGEREF _Toc295496626 \h 4 4.2 文档类型声明 PAGEREF _Toc295496627 \h 4 4.3 语法 PAGEREF _Toc295496628 \h 4 4.4 文件引入 PAGEREF _Toc295496629 \h 5 4.5 语义化 html PAGEREF _Toc295496630 \h 5 5、css 书写规范 PAGEREF _Toc295496631 \h 6 5.1 编码 PAGEREF _Toc295496632 \h 6 5.2 协作开发及分工 PAGEREF _Toc295496633 \h 6 5.3 CSS语法 PAGEREF _Toc295496634 \h 6 5.4 class 与 id 命名 PAGEREF _Toc295496635 \h 6 5.6 属性列举 PAGEREF _Toc295496636 \h 7 5.7 CSS优化 PAGEREF _Toc295496637 \h 7 6、Javascript 书写规范 PAGEREF _Toc295496638 \h 7 6.1 编码 PAGEREF _Toc295496639 \h 7 6.2 语法 PAGEREF _Toc295496640 \h 7 6.3 变量命名 PAGEREF _Toc295496641 \h 7 6.4 变量声明 PAGEREF _Toc295496642 \h 8 7、注释规范 PAGEREF _Toc295496643 \h 8 7.1 html 注释 PAGEREF _Toc295496644 \h 8 7.2 css 注释 PAGEREF _Toc295496645 \h 8 7.3 JavaScript 注释 PAGEREF _Toc295496646 \h 8 8、图片规范 PAGEREF _Toc295496647 \h 8 9、开发测试工具约定 PAGEREF _Toc295496648 \h 9 1、规范目的 为提高团队协作效率,便于后台开发人员套页面及前端后期优化维护,输出 高质量的文档,特制订此文档。本规范文档一经确认,前端开发人员必须按本文档规范进行前端页面制作。本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改。 2、基本准则 编写符合 w3c 标准,语义化的 html,实现结构、表现、行为分离;浏览器兼容性优良(暂定 IE、chrome、firefox)。 页面性能方面,代码要求简洁有序, 尽可能的减小服务器负载,注重 css 代码质量,保证浏览器能最快的解析。 3、文件规范 3.1 目录结构 css、js、images 文件均归档至约定的目录中。 约定目录为: / /index.html /images/ /css/ base.css /js/ common.js jquery-1.9..min.js 可根据需要创建子目进行分类。 3.2 html 文件命名 英文命名,后缀为.html 3.3 css 文件命名 英文命名,后缀为.css。公用 css 请放在 base.css 中,重置样式浏览器内置样式的 css 为 reset.css,其它css 文件根据页面名称命名。 3.4 js文件命名 英文命名, 后缀为.js。公用 js 请放在 common.js 中, 其他依模块需求命名。 注:所有文件命名,由多个单词组成时,采用中划线连接方式,比如:账号 模型文件 account-model.js,错误报告页面 error-report.