1、Web 前端开发规范手册一、规范目的1.1 概述 . 1二、文件规范2.1 文件命名规则.12.2 文件存放位置.22.3 css 书写规范.32.4 html书写规范.72.5 JavaScript书写规范.112.6 图片规范.122.7 注释规范.132.8 css 浏览器兼容.13一、规范目的1.1 概述为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档.二、文件规范2.1 文件命名规则文件名称统一
2、用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。a. HTML 的命名原则引文件统一使用 index.htm index.html index.asp 文件名（小写）各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： 关于我们 aboutus 信息反馈 feedback 产 品 product如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏
3、目名称拼音或拼音的首字母表示；每一个目录中应该包含一个缺省的 html 文件，文件名统一用 index.htm index.html index.asp；b. 图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质例如：广告、标志、菜单、按钮等等。放置在页面顶部的广告、装饰图案等长方形的图片取名： banner标志性的图片取名为： logo在页面上位置不固定并且带有链接的小图片我们取名为 button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名： menu 装饰用的照片我们取名： pic不带链接表示标题的图片我们取名： title 范例：banner
4、_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg鼠标感应效果图片命名规范为“图片名+_+on/off“ 。例如：menu1_on.gif menu1_off.gifc. javascript 的命名原则例如：广告条的 javascript 文件名为 ad.js 弹出窗口的 javascript 文件名为 pop.jsd. 动态语言文件命名原则以性质_描述，描述可以有多个单词，用“_ ”隔开，性质一般是该页面
5、得概要。范例：register_form.asp register_post.asp topic_lock.asp2.2 文件存放位置规范_Rootcn 存放中文 HTML 文件en 存放英文 HTML 文件flash 存放 Flash 文件images 存放图片文件imagestudio 存放 PSD 源文件flashstudio 存放 flash 源文件inc 存放 include 文件library 存放 DW 库文件media 存放多媒体文件project 存放工程项目资料temp 存放客户原始资料js 存放 JavaScript 脚本css 存放 CSS 文件2.3 CSS 书写规范
6、基本原则：CSS 样式可细分为 3 类：自定义样式、重新定义 HTML 样式、链接状态样式。1. 样式为设计师自定义的新 CSS 样式，影响被使用本样式的区域，用于完成网页中局部的样式设定。样式名 “.”+“相应样式效果描述的单词或缩写”例：“ .shadow ”文字样式样式名“.no”+“字号”+“行距”+ “颜色缩写”例：“ .no12 ” 、 “ .no12-24 ”2. 义 HTML 样式为设计师重新定义已有的 HTML 标签样式，影响全部的被设定标签样式，用于统一网页中某一标签的样式定义。样式名“HTML 标签”例：hr border: 1px dotted #333333 3. 态
7、样式为设计师对链接不同状态设定特殊样式，影响被使用本样式区域中的链接。该样式写法有 2 种： a.nav:link nav.a:link 第一种只能修饰 标签中；第二种可以修饰所有包含有 标签的其他标签。页面内的样式加载必须用链接方式注意细则：1. 协作开发及分工: i 会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构 共用 css 文件 base.css 由 i 书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含 reset 及头部底部样式 , 此文件不可随意修改;2. class 与 id 的使用: id 是唯一的并是父级的, cla
8、ss 是可以重复的并是子级的, 所以 id 仅使用在大的模块上, class 可用在重复使用率高及子级中; id 原则上都是由我分发框架文件时命名的 , 为 JavaScript 预留钩子的除外;3. 为 JavaScript 预留钩子的命名 , 请以 js_ 起始, 比如: js_hide, js_show;4. class 与 id 命名: 大的框架命名比如 header/footer/wrapper/left/right 之类的在 2 中由 i 统一命名.其他样式名称由 小写英文 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.5. 规避 class 与 i
9、d 命名(此条重要, 若有不明白请及时与 i 沟通): a, 通过从属写法规避, 示例见 d; b, 取父级元素 id/class 命名部分命名 , 示例见 d; c, 重复使用率高的命名, 请以自己代号加下划线起始, 比如 i_clear; d, a,b 两条, 适用于在 2 中已建好框架的页面, 如, 要在 2 中已建好框架的页面代码中加入新的 div 元素,按 a 命名法则 : ., 样式写法: #mainnav .firstnav.按 b 命名法则 : ., 样式写法: .main_firstnav.6. css 属性书写顺序, 建议遵循 布局定位属性自身属性文本属性 其他属性. 此条
10、可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: margin、padding、float（包括 clear） 、position（相应的 top,right,bottom,left） 、display、visibility 、overflow 等；自身属性主要包括: width 文本属性主要包括： font、color、text-align、text-decoration、text-indent 等；其他属性包括: list-style(列表样式)、 vertical-vlign、cursor、z-index(层叠顺序) 、zoom 等.我所列出的这些属
11、性只是最常用到的, 并不代表全部;7. 书写代码前, 考虑并提高样式重复使用率;8. 充分利用 html 自身属性及样式继承原理减少代码量, 比如:这儿是标题列表 2010-09-15定义 ul.list liposition:relative ul.list li spanposition:absolute; right:0即可实现日期居右显示9. 样式表中中文字体名, 请务必转码成 unicode 码, 以避免编码错误时乱码;10. 背景图片请尽可能使用 sprite 技术, 减小 http 请求, 考虑到多人协作开发 , sprite 按模块制作;11. 使用 table 标签时(尽量避
12、免使用 table 标签), 请不要用 width/ height/cellspacing/cellpadding 等table 属性直接定义表现 , 应尽可能的利用 table 自身私有属性分离结构与表现 , 如thead,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing 及 cellpadding 的 css 控制方法: tableborder:0;margin:0;border-collapse:collapse; table th, table tdpadding:0; , base.css 文件中我会初始化表格样式)12. 杜绝使用 兼
13、容 ie8;13. 用 png 图片做图片时, 要求图片格式为 png-8 格式,若 png-8 实在影响图片质量或其中有半透明效果, 请为 ie6 单独定义背景:background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=img/bg.png);14. 避免兼容性属性的使用, 比如 text-shadow | css3 的相关属性 ;15. 减少使用影响性能的属性, 比如 position:absolute | float ;16. 必须为大区块样式添加注释
14、, 小区块适量注释;17. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化 i 会统一处理;命名规则：头：header内容：content/container尾：footer导航：nav侧栏：sidebar栏目：column页面外围控制整体布局宽度：wrapper左右中：left right center登录条：loginbar标志：logo广告：banner页面主体：main热点：hot新闻：news下载：download子导航：subnav菜单：menu子菜单：submenu搜索：search友情链接：friendlink页脚：footer版权：copyright滚动：scr
15、oll内容：content标签页：tab文章列表：list提示信息：msg小技巧：tips栏目标题：title加入：joinus指南：guild服务：service注册：regsiter状态：status投票：vote合作伙伴：partner(二) 注释的写法:/* Footer */内容区/* End Footer */(三)id 的命名:(1)页面结构容器: container页头：header内容：content/container页面主体：main页尾：footer导航：nav侧栏：sidebar栏目：column页面外围控制整体布局宽度：wrapper左右中：left right c
16、enter(2)导航导航：nav主导航：mainbav子导航：subnav顶导航：topnav边导航：sidebar左导航：leftsidebar右导航：rightsidebar菜单：menu子菜单：submenu标题: title摘要: summary(3)功能标志：logo广告：banner登陆：login登录条：loginbar注册：regsiter搜索：search功能区：shop标题：title加入：joinus状态：status按钮：btn滚动：scroll标签页：tab文章列表：list提示信息：msg当前的: current小技巧：tips图标: icon注释：note指南：g
17、uild服务：service热点：hot新闻：news下载：download投票：vote合作伙伴：partner友情链接：link版权：copyright基本样式： /* CSS Document */body margin:0; padding:0; font:12px “5B8B4F53“,san-serif;background:#fff;div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,blockquote,ppadding:0; margin:0; table,td,tr,thfont-
18、size:12px;lilist-style-type:none;imgvertical-align:top;border:0;ol,ul list-style:none;h1,h2,h3,h4,h5,h6 font-size:12px; font-weight:normal;address,cite,code,em,th font-weight:normal; font-style:normal;.fBfont-weight:bold;.f12pxfont-size:12px;.f14pxfont-size:14px;.leftfloat:left;.rightfloat:right;a c
19、olor:#2b2b2b; text-decoration:none;a:visited text-decoration:none;a:hover color:#ba2636;text-decoration:underline;a:active color:#ba2636;重定义的最先，伪类其次，自定义最后，便于自己和他人阅读！不同浏览器上字号保持一致，字号建议用点数 pt 和像素 px 来定义，pt 一般使用中文宋体的 9pt 和11pt，px 一般使用中文宋体 12px 和 14.7px 这是经过优化的字号，黑体字或者宋体字加粗时，一般选用11pt 和 14.7px 的字号比较合适。中英文
20、混排时，我们尽可能的将英文和数字定义为 verdana 和 arial 两种字体。2.4 html 书写规范1. 网页制作细节 - head 区代码规范 head 区是指 HTML 代码的和之间的内容。 必须加入的标签 a) 公司版权注释 b) 网页显示字符集 简体中文：繁体中文：英 语：c) 网页制作者信息 d) 网站简介 e) 搜索关键字 f) 网页的 css 规范 g) 网页标题 xxxxxxxxxxxxxxxxxx可以选择加入的标签 a) 设定网页的到期时间。一旦网页过期，必须到服务器上重新调阅。 b) 禁止浏览器从本地机的缓存中调阅页面内容。 c) 用来防止别人在框架里调用你的页面。
21、d) 自动跳转。5 指时间停留 5 秒e) 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引。CONTENT 的参数有 all,none,index,noindex,follow,nofollow。默认是 all。 f) 收藏夹图标 g) 所有的 javascript 的调用尽量采取外部调用. h) 附标签： 标签不属于 head 区，这里强调一下，为了保证浏览器的兼容性，必须设置页面背景2. 网页制作细节 - 字体1. 在设定字体样式时对于文字字号样式和行间距应必须使用 CSS 样式表。禁止在页面中出现 标记。2.在网页中中文应首选使用宋体。英文和数字首选使用 ve
22、rdana 和 arial 两种字体。一般使用中文宋体的9pt 和 11pt 或 12px 和 14.7px 这是经过优化的字号，黑体字或者宋体字加粗时，一般选用 11pt 和14.7px 的字号比较合适。3. 为了最大程度的发挥浏览器自动排版的功能，在一段完整的文字中请尽量不要使用 来人工干预分段。4.不同语种的文字之间应该有一个半角空格，但避头的符号之前和避尾的符号之后除外，汉字之间的标点要用全角标点，英文字母和数字周围的括号应该使用半角括号。 5. 请不要在网页中连续出现多于一个的 也尽量少使用全角空格（英文字符集下，全角空格会变成乱码），空白应该尽量使用 text-indent, pa
23、dding, margin, hspace, vspace 以及透明的 gif 图片来实现。 6. 行距建议用百分比来定义，常用的两个行距的值是 line-height:120%/150%. 7. 排版中我们经常会遇到需要进行首行缩进的处理，不要使用 或者全角空格来达到效果，规范的做法是在样式表中定义 p text-indent: 2em; 然后给每一段加上 标记，注意，一般情况下，请不要省略 结束标记 。3. 网页制作细节 - 链接1. 网站中的链接路径全部采用相对路径，一般链接到某一目录下的缺省文件的链接路径不必写全名，如我们不必这样： 而应该这样：，所有内页指向首页的链接写成2. 在浏览
24、器里，当我们点击空链接时，它会自动将当前页面重置到首端，从而影响用户正常的阅读内容，我们用代码“javascript:void(null) ”代替原来的“#”标记4. 网页制作细节 - 表格1px 表格 style=“border-collapse: collapse“实例如下：设置亮、暗边框颜色表格有亮边框（bordercolorlight ）和暗边框（bordercolordark ）两个属性可以对表格样式设置。在写 互相嵌套时 ，严格按照的规范，对于单独的一个 来说， 对齐， 缩进两个半角空格， 中如果还有嵌套的表格，也缩进两个半角空格，如果 中没有任何嵌套的表格， 结束标记应该与 处于
25、同一行，不要换行，如我们注意在源代码中不应有这样的代码：而应该是这样的：这是因为浏览器认为换行相当于一个半角空格，以上不规范的写法相当于无意中增加一个半角空格，如果确实有必要增加一个半角空格，也应该这样写： 一个网页要尽量避免用整个一张大表格，所有的内容都嵌套在这个大表格之内，因为浏览器在解释页面的元素时，是以表格为单位逐一显示，如果一张网页是嵌套在一个大表格之内，那么很可能造成的后果就是，当浏览者敲入网址，他要先面对一片空白很长时间，然后所有的网页内容同时出现。如果必须这样做，请使用 标记，以便能够使这个大表格分块显示5. 网页制作细节 - 下载速度首页 Flash 网页大小应限定在 200
26、K 以下，尽可能的使用矢量图形和 Action 来减小动画大小。非首页静态页面含图片大小应限定在 70K 左右，尽可能的使用背景颜色替换大块同色图片。6. 网页制作细节 - includeasp 标准写法 jsp 标准写法 7. 网页制作细节 - Alt和 Title 都是提示性语言标签，请注意它们之间的区别。 在我们浏览网页时，当鼠标停留在图片对象或文字链接上时，在鼠标的右下角有时会出现一个提示信息框。对目标进行一定的注释说明。在一些场合，它的作用是很重要的。 alt 用来给图片来提示的。Title用来给链接文字或普通文字提示的。 用法如下： 文字 文字 8. 网页制作细节 - 缓存 网页不
27、会被缓存 HTM网页 ASP网页 Response.Expires = -1 Response.ExpiresAbsolute = Now() - 1 Response.cachecontrol = “no-cache“9. 网页制作细节 - 浏览器兼容性创建站点时，应该明白访问者可能使用各种 Web 浏览器。在已知的其他设计限制下，尽可能将站点设计为具有最大的浏览器兼容性。目前使用的 Web 浏览器有二十多种，大多数已发行了多个版本。即使您只针对使用 Netscape Navigator 和 Microsoft Internet Explorer 的大多数 Web 用户，但您应明确并不是每个
28、人都在使用这两种浏览器的最新版本。您的站点越复杂（在布局、动画、多媒体内容和交互方面） ，跨浏览器兼容的可能性就越小。例如，并非所有的浏览器都可以运行 JavaScript。不使用特殊字符的纯文本页面或许能够在任何浏览器中正确显示，但比起有效地使用图形、布局和交互的页面，这样的页面在美感上可能要差得多。所以，应尽量在最佳效果设计和最大浏览器兼容性设计之间取得平衡。所有的 HTML 标签的属性都要用单引号或者双引号括起，即我们应该写 而不 是 .10. 图片处理细节 - banner全尺寸 banner 为 468X60px，半尺寸 banner 为 234X60px，小 banner 为 88
29、X31px。另外 120X90，120X60 也是小图标的标准尺寸。全尺寸 banner 不超过 14K。普遍的 banner 尺寸 760X100，750X120，468X60，468X95 ，728X90，585X140次级页的 pip 尺寸 360X300，336X280游标:100X100 或 120X12011. 图片处理细节 - LOGO 的国际标准规范为了便于 INTERNET 上信息的传播，一个统一的国际标准是需要的。实际上已经有了这样的一整套标准。其中关于网站的 LOGO，目前有三种规格：88*31 这是互联网上最普遍的 LOGO 规格。120*60 这种规格用于一般大小的 LOGO。
