Web前端开发规范手册:为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档.
2.1 文件命名规则
文件名称统一用小写的英文字母、数字和下划线的组合,其中不得包含汉字、空格和特殊字符;
命名原则的指导思想:
- 使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义,
- 是当我们在文件夹中使用“按名称排例”的命令时,同一种大类的文件能够排列在一起,以便我们查找、修改、替换、计算负载量等等操作。
HTML的命名原则
引文件统一使用index.htm index.html index.asp文件名(小写)
各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如:
- 关于我们 \ aboutus
- 信息反馈 \ feedback
- 产 品 \ product
如果栏目名称多而复杂并不好以英文单词命名,则统一使用该栏目名称拼音或拼音的首字母表示;
每一个目录中应该包含一个缺省的html 文件,文件名统一用index.htm index.html index.asp;
图片的命名原则
图片的名称分为头尾两部分,用下划线隔开,头部分表示此图片的大类性质
例如:广告、标志、菜单、按钮等等。
- 放置在页面顶部的广告、装饰图案等长方形的图片取名: banner
- 标志性的图片取名为: logo
- 在页面上位置不固定并且带有链接的小图片我们取名为 button
- 在页面上某一个位置连续出现,性质相同的链接栏目的图片我们取名: menu
- 装饰用的照片我们取名: pic
- 不带链接表示标题的图片我们取名: title
范例:
- banner_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.gif
javascript的命名原则
例如:广告条的javascript文件名为 ad.js 弹出窗口的javascript文件名为 pop.js
动态语言文件命名原则
以性质描述,描述可以有多个单词,用“”隔开,性质一般是该页面得概要。
范例:register_form.asp register_post.asp topic_lock.asp
2.2 文件存放位置规范
1 | _Root |
2.3 CSS 书写规范
基本原则:
CSS样式可细分为3类:自定义样式、重新定义HTML样式、链接状态样式。
样式为设计师自定义的新 CSS 样式,影响被使用本样式的区域,用于完成网页中局部的样式设定。
样式名 “.”+“相应样式效果描述的单词或缩写”例:“ .shadow ”
文字样式样式名“.no”+“字号”+“行距”+“颜色缩写”例:“ .no12 ” 、“ .no12-24 ”
义HTML样式为设计师重新定义已有的HTML标签样式,影响全部的被设定标签样式,用于统一网页中某一标签的样式定义。
- 样式名“HTML标签”例:hr { border: 1px dotted #333333 }
态样式为设计师对链接不同状态设定特殊样式,影响被使用本样式区域中的链接。
- 该样式写法有2种:
1 | a.nav:link nav.a:link 第一种只能修饰<a>标签中;第二种可以修饰所有包含有<a>标签的其他标签。 |
- 页面内的样式加载必须用链接方式
1 | <link rel="stylesheet" type="text/css" href="style/style.css"> |
注意细则:
协作开发及分工:
i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件base.css由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改;
class与id的使用:
id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由我分发框架文件时命名的, 为JavaScript预留钩子的除外;
为JavaScript预留钩子的命名,
请以 js_ 起始, 比如: js_hide, js_show;
class与id命名:
大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由 小写英文 & 数字 & _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.
规避class与id命名(此条重要, 若有不明白请及时与i沟通):
- 通过从属写法规避, 示例见d;
- 取父级元素id/class命名部分命名, 示例见d;
- 重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear;
a,b两条, 适用于在2中已建好框架的页面, 如, 要在2中已建好框架的页面代码
中加入新的div元素,按a命名法则:
1 | <div id="mainnav"><div class="firstnav">...</div></div>, |
- 样式写法:
1 | #mainnav .firstnav{.......} |
- 按b命名法则:
1 | <div id="mainnav"><div class="main_firstnav">...</div></div>, |
- 样式写法:
1 | .main_firstnav |
css属性书写顺序
建议遵循 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: margin、padding、float(包括clear)、position(相应的 top,right,bottom,left)、display、visibility、overflow等;自身属性主要包括: width & height & background & border; 文本属性主要包括:font、color、text-align、text-decoration、text-indent等;其他属性包括: list-style(列表样式)、vertical-vlign、cursor、z-index(层叠顺序) 、zoom等.我所列出的这些属性只是最常用到的, 并不代表全部;
书写代码前, 考虑并提高样式重复使用率;
充分利用html自身属性及样式继承原理减少代码量
比如:
1 | <ul class="list"><li>这儿是标题列表<span>2010-09-15</span></ul> |
定义ul.list li{position:relative} ul.list li span{position:absolute; right:0}
即可实现日期居右显示
样式表中中文字体名
请务必转码成unicode码, 以避免编码错误时乱码;
背景图片请尽可能使用sprite技术
减小http请求, 考虑到多人协作开发, sprite按模块制作;
使用table标签时(尽量避免使用table标签)
请不要用width/ height/cellspacing/cellpadding等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现, 如thead,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing及cellpadding的css控制方法: table{border:0;margin:0;border-collapse:collapse;} table th, table td{padding:0;} , base.css文件中我会初始化表格样式)
杜绝使用 兼容ie8;
用png图片做图片时
要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:
background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’);
避免兼容性属性的使用
比如text-shadow || css3的相关属性;
减少使用影响性能的属性
比如position:absolute || float ;
必须为大区块样式添加注释, 小区块适量注释;
代码缩进与格式:
建议单行书写, 可根据自身习惯, 后期优化i会统一处理;
命名规则:
1 | 头:header |
注释的写法:
1 | /* Footer */ |
id的命名:
页面结构
1 | 容器: container |
导航
1 | 导航:nav |
功能
1 | 标志:logo |
基本样式:
1 | /* CSS Document */ |
重定义的最先,伪类其次,自定义最后,便于自己和他人阅读!
- 不同浏览器上字号保持一致,字号建议用点数pt和像素px来定义。
- pt一般使用中文宋体的9pt 和11pt,px一般使用中文宋体12px 和14.7px
- 这是经过优化的字号,黑体字或者宋体字加粗时,一般选用11pt 和14.7px 的字号比较合适。
- 中英文混排时,我们尽可能的将英文和数字定义为verdana 和arial 两种字体。
2.4 html 书写规范
网页制作细节 —- head区代码规范
1 | head区是指HTML代码的<head>和</head>之间的内容。 |
必须加入的标签
1 | 公司版权注释 |
可以选择加入的标签
1 | 设定网页的到期时间。一旦网页过期,必须到服务器上重新调阅。 |
网页制作细节 —- 字体
1 | 1. 在设定字体样式时对于文字字号样式和行间距应必须使用CSS样式表。禁止在页面中出现 <font size=?> 标记。 |
网页制作细节 —- 链接
1 | 1. 网站中的链接路径全部采用相对路径,一般链接到某一目录下的缺省文件的链接路径不必写全名,如我们不必这样:<a href=”aboutus/index.htm”> 而应该这样:<a href=”aboutus/”>,所有内页指向首页的链接写成<a href=”/”> |
网页制作细节 —- 表格
1 | 1px表格 style="border-collapse: collapse" |
网页制作细节 —- 下载速度
首页Flash 网页大小应限定在 200K 以下,尽可能的使用矢量图形和Action来减小动画大小。非首页静态页面含图片大小应限定在 70K 左右,尽可能的使用背景颜色替换大块同色图片。
网页制作细节 —- include
asp标准写法
jsp 标准写法 <%@ include file=”../inc/index_top..jsp” %>
网页制作细节 —- Alt和Title
1 | 都是提示性语言标签,请注意它们之间的区别。 |
网页制作细节 —- 缓存
网页不会被缓存
HTM网页
ASP网页
Response.Expires = -1
Response.ExpiresAbsolute = Now() - 1
Response.cachecontrol = “no-cache”
网页制作细节 —- 浏览器兼容性
1 | 创建站点时,应该明白访问者可能使用各种 Web 浏览器。在已知的其他设计限制下,尽可能将站点设计为具有最大的浏览器兼容性。 |
图片处理细节 —- banner
1 | 全尺寸banner为468X60px,半尺寸banner为234X60px,小banner为88X31px。 |
图片处理细节 —- LOGO的国际标准规范
为了便于INTERNET上信息的传播,一个统一的国际标准是需要的。实际上已经有了这样的一整套标准。其中关于网站的LOGO,目前有三种规格:
8831 这是互联网上最普遍的LOGO规格。
12060 这种规格用于一般大小的LOGO。
120*90 这种规格用于大型LOGO。
图片处理细节 —- 页面修饰图片处理
图片经过优化以加快下载的速度,有较佳的视觉空间效果,用图要与页面风格、页面内容相符;制作精美,细节处理得当。
2.5 JavaScript书写规范
- 书写过程中, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || …);
- 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;
- 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun; jQuery变量要求首字符为’_’, 其他与原生JavaScript 规则相同, 如: _iTaoLun; 另, 要求变量集中声明, 避免全局变量.
- 类命名: 首字母大写, 驼峰式命名. 如 ITaoLun;
- 函数命名: 首字母小写驼峰式命名. 如iTaoLun();
- 命名语义化, 尽可能利用英文单词或其缩写;
- 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;
- 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;
- 代码结构明了, 加适量注释. 提高函数重用率;
- 注重与html分离, 减小reflow, 注重性能.
2.6 图片规范
- 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;
- 图片格式仅限于gif || png || jpg;
- 命名全部用小写英文字母 || 数字 || _ 的组合,其中不得包含汉字 || 空格 || 特殊字符;尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;
- 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;
- 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);
- 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.
2.7 注释规范
- html注释: 注释格式 , ‘–’只能在注释的始末位置,不可置入注释文字区域;
- css注释: 注释格式 /这儿是注释/;
- JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 / 这儿有多行注释 /;
2.8 浏览器兼容性 CSS hack
标识区别:
1 | 区别IE6,IE7,IE8,FF。 |
IE6和firefox的区别:
background:orange;
*background:blue;
意思就是火狐浏览器的背景颜色是橙色,而IE浏览器的背景色是蓝色.
IE6和IE7的区别:
background:green !important;
background:blue;
意思指的是:IE7的背景颜色是绿色,IE6的背景颜色是蓝色
IE7和FF的区别:
background:orange;
*background:green;
意思指的是:火狐浏览器的背景颜色是橙色,而IE7的背景颜色是绿色
FF,IE7,IE6的区别:
1 | background:orange; |
实践建议
开发平台的选择
在 Firefox 上编写CSS, 同时兼容其他浏览器的. 这样做肯定会比在 IE 做好再到别的浏览器兼容来得容易, 因为 IE 对老标准支持还是很不错的, 而 IE 的一些特有功能人家却不支持. 所以推荐以 Firefox 结合 Firebug 扩展作为平台。
CSS Hack 的顺序
使用 Firefox 作为平台, 只要代码写得够标准, 其实要 Hack 的地方不会很多的, IE 以外的浏览器几乎都不会有问题, 所以可以暂时忽略,
顺序如下:Firefox -> IE6 -> IE7 -> 其他
Hack 的方法
1 | 说到方法有两种, 一种是在不同文件中处理, 另一种则是在同一个文件中处理. 其实作用是相同的, 只是出发点不一样而已. |
属性 | 功能 |
---|---|
/…/ – 注释 | |
azimuth | |
background-attachment | 背景图片随滚动轴的移动方式 |
background-color | 背景颜色 |
background-image | 背景图像 |
background-position | 背景图片的位置 |
background-repeat | 背景图片的显示方式 |
background | 统一背景 |
border | 统一边框所有属性 |
border-bottom | 统一下边框 |
border-bottom-color | 下边框颜色 |
border-bottom-style | 下边框样式 |
border-bottom-width | 下边框宽度 |
border-break | 内容分开的边框 |
border-collapse | |
border-color | 边框颜色 |
border-left | 统一左边框 |
border-image | 边框图像 |
border-left-color | 左边框颜色 |
border-left-style | 左边框样式 |
border-left-width | 左边框宽度 |
border-radius | 圆角边框 |
border-right-color | 右边框颜色 |
border-right-style | 右边框样式 |
border-right-width | 右边框宽度 |
border-right | 统一右边框 |
border-spacing | |
border-style | 边框样式 |
border-top | 统一上边框 |
border-top-color | 上边框颜色 |
border-top-style | 上边框样式 |
border-top-width | 上边框宽度 |
border-width | 统一边框宽度 |
bottom | 下偏移属性 |
caption-side | |
clear | 清除 |
clip | 了盒子可显示的区域 |
color | 颜色 |
content | 字符串 |
counter-increment | |
counter-reset | |
cue-after | |
cue-before | |
cue | |
cursor | 鼠标样式 |
direction | |
display | 显示方式 |
elevation | |
empty-cells | |
float | 元素漂浮 |
font-family– 字体 | |
font-size | 字体大小 |
font-style | 字体样式 |
font-variant | 小型的大写字母字体 |
font-weight | 字体粗细 |
font | 统一字体所有属性 |
height | 盒子高度 |
left | 左偏移属性 |
letter-spacing | 文本中字母的间距(中文为文字的间距) |
line-height | 一段文字中每行文字的间距 |
list-style-image | 列表图像 |
list-style-position | 列表位置 |
list-style-type | 列表类型 |
list-style | 统一列表所有属性 |
margin-right | 右边外补白宽度 |
margin-left | 左边外补白宽度 |
margin-top | 上边外补白宽度 |
margin-bottom | 下边外补白宽度 |
margin | 统一边外补白 |
max-height | 最大高度 |
max-width | 最大宽度 |
min-height | 最小高度 |
min-width | 最小宽度 |
opacity | 元素的透明度 |
orphans | |
outline-color | |
outline-style | |
outline-width | |
outline | |
overflow | 盒子中内容的显示方式 |
padding-top | 上边内补白 |
padding-right | 右边内补白 |
padding-bottom | 下边内补白 |
padding-left | 左边内补白 |
padding | 统一边内补白 |
page-break-after | |
page-break-before | |
page-break-inside | |
pause-after | |
pause-before | |
pause | |
pitch-range | |
pitch | |
play-during | |
position | 元素的定位 |
quotes | |
richness | |
right | 右偏移属性 |
speak-header | |
speak-numeral | |
speak-punctuation | |
speak | |
speech-rate | |
stress | |
table-layout | |
text-align | 文本对齐方式 |
text-decoration | 文本是否有划线以及划线的方式 |
text-indent | 文本的首行缩进 |
text-transform | 文本的大小写状态,此属性对中文无意义 |
top | 上偏移属性 |
unicode-bidi | |
vertical-align | 垂直对齐方式 |
visibility | 元素是否可见 |
voice-family | |
volume | |
white-space | 文本的格式 |
widows | |
width | 盒子宽度 |
word-spacing | 以空格间隔文字的间距 |
z-index | z轴顺序 |
HTML标签索引 – 按照字母顺序
引用
属性 | 功能 |
---|---|
!–…– | HTML注释 |
!DOCTYPE | 文档类型 |
a | 链接 |
abbr | 缩写(例如:WWW,HTTP,HTML etc.) |
acronym | 定义首字母缩写 |
address | 定义一个地址元素 |
applet | 定义一个JAVA的applet |
area | 定义一个图像地图区域 |
b | 定义粗体文字 |
base | 定义一个基URL用于页面的链接与引用 |
basefont | 定义基本字体 |
bdo | 定义文字的显示方向 |
big | 定义大字体的文字 |
blockcode | 定义代码段 |
blockquote | 定义一段引用 |
body | 定义HTML文档体 |
br | 定义换行 |
button | 定义一个按钮 |
caption | 定义表格的说明 |
center | 定义居中 |
cite | 定义引用 |
code | 定义程序代码 |
col | 定义一个表格的栏目 |
colgroup | 定义一个表格的栏目组 |
dd | 定义列表一个组的描述 |
del | 定义被删除的文字 |
dfn | 定义一个元素的额外说明 |
dir– 定义一个多栏目的目录列表 | |
div | 定义一个块元素 |
dl | 定义一个自定义列表 |
dt | 定义一个列表组 |
em | 定义强调显示的内容 |
embed | 在网页中嵌入除图片外的多媒体 |
fieldset | 定义一组表单 |
font | 定义字体 |
form | 定义一个表单 |
frame | 定义一个子框架(窗口) |
frameset | 定义一个框架 |
h1 h2 h3 h4 h5 h6 | 定义标题1至标题6 |
head | 定义一个HTML文档的头信息 |
hr | 定义一个水平线 |
html | 定义一个HTML文档的开始 |
i | 定义斜体文字 |
iframe | 定义一个内联的框架(窗口) |
img | 定义一个图像 |
input | 定义一个表单的输入域 |
ins | 定义被插入的文字 |
isindex | 定义一个单行的输入域 |
kbd | 表明用户输入的文字 |
l | 定义一个行 |
label | 定义一个表单的域的说明 |
legend | 定义一组表单的标题(与fieldset一起使用) |
li | 定义列表的内容 |
link | 定义一个资源的引用 |
listing | 定义小号文字,字体为monospaced |
map | 定义一个图像地图 |
menu | 定义一个单栏目的菜单列表 |
meta | 定义meta信息 |
nobr | 定义在一行显示内容 |
noframes | 定义框架无法显示的切换内容 |
noscript | 定义脚本无法执行的切换内容 |
object | 定义一个内嵌的物件(例如:图像, 媒体, 代码 etc) |
ol | 定义一个有序列表 |
optgroup | 定义一个选择组 |
option | 定义一个选择的下拉列表 |
p | 定义段落 |
param | 定义一个物件的参数 |
plaintext | 定义简单文字,字体为monospaced |
pre | 按预定义格式显示 |
q | 定义一个简短的内联引用 |
quote | 定义一个简短的内联引用 |
s | 定义删除线的文字 |
samp | 一段输出的脚本,程序 |
script | 定义一个脚本的开始 |
section | 定义标题段 |
select | 定义一个选择列表 |
separator | 定义一个段落分隔 |
small | 定义小字体的文字 |
span | 定义文档中的一段 |
strike | 定义删除线样式的文字 |
strong | 定义要强调显示的内容 |
style | 定义一个样式 |
sub | 定义下标 |
sup | 定义上标 |
table | 定义一个表格 |
tbody | 定义表格的身体 |
td | 定义表格的数据单元 |
textarea | 定义一个多行的文字输入域 |
tfoot | 定义表格的尾部 |
th | 定义表格的标题单元 |
thead | 定义表格的头部 |
title | 定义HTML文档的标题 |
tr | 定义表格的一行 |
tt | 定义单间距的文字 |
u | 定义下划线样式的文字 |
ul | 定义一个无序列表 |
var | 表明一个程序的变量 |
wbr | 定义在nobr中强迫换行 |
xmp | 预定义格式文字显示 |
属性 | 功能 |
---|---|
cmd | 打开dos窗口 |
ipconfig | 查看ip地址 |
\192.168.1.*\C$ | 侵入别人的计算机桌面 |
ping | ping别人的ip地址 |
route print | 查看网关和端口 |
ftp | 打开ftp共享程序 |
shutdown -s -t 10 | 设置关机 |
shutdown -r -t 10 | 设置重启 |
tree | 将盘符以树状显示 |
dir | 显示盘符的所有内容 |
winver | 查看系统信息 |
edit | 打开编辑页面 |
cd.. | 后退一步 |
md e:\123 | 新建文件夹 |
rd e:\123 | 删除文件夹 |
regedit | 打开编辑器 |
control | 打开控制面板 |
systeminfo | 查看系统信息 |
在开始运行中输入 | dxdiag |