Web前端开发规范文档你需要知道的事--HTML、css、js、文档等需要规范内容
规范目的
为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档.本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发.本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改.
基本准则
符合web标准,语义化html,结构表现行为分离,兼容性优良.页面性能方面,代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度.
文件规范
1.html,css,js,images文件均归档至<系统开发规范>约定的目录中;
2.html文件命名:英文命名,后缀.htm.同时将对应界面稿放于同目录中,若界面稿命名为中文,请重命名与html文件同名,以方便后端添加功能时查找对应页面;
3.css文件命名:英文命名,后缀.css.共用base.css,首页index.css,其他页面依实际模块需求命名.;
4.Js文件命名:英文命名,后缀.js.共用common.js,其他依实际模块需求命名.
html书写规范
1.文档类型声明及编码:统一为html5声明类型;编码统一为,书写时利用IDE实现层次分明的缩进;
2.非特殊情况下样式文件必须外链至…之间;非特殊情况下JavaScript文件必须外链至页面底部;
3.引入样式文件或JavaScript文件时,须略去默认类型声明.
4.引入JS库文件,文件名须包含库名称及版本号及是否为压缩版,比如jquery-1.7.1.min.js;引入插件,文件名格式为库名称+插件名称,比如jQuery.cookie.js;
5.所有编码均遵循xhtml标准,标签&属性&属性命名必须由小写字母及下划线数字组成,且所有标签必须闭合;属性值必须用双引号包括;
6.充分利用无兼容性问题的html自身标签,比如span,em,strong,optgroup,label,等等;需要为html元素添加自定 义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等 其他命名方式;
7.语义化html,如标题根据重要性用h(同一页面只能有一个h1),段落标记用p,列表用ul,内联元素中不可嵌套块级元素;
8.尽可能减少div嵌套
9.书写链接地址时,必须避免重定向,例如:href=”http://www.example.com/”,即须在URL地址后面加上“/”;
10.在页面中尽量避免使用style属性,即style=”…”;
11.必须为含有描述性表单元素(input,textarea)添加label
12.能以背景形式呈现的图片,尽量写入css样式中;
13.重要图片必须加上alt属性;给重要的元素和截断的元素加上title;
14.给区块代码及重要功能(比如循环)加上注释,方便后台添加功能;
15.特殊符号使用:尽可能使用代码替代:比如<(<)&>(>)&空格()&»(»)等等;
16.书写页面过程中,请考虑向后扩展性;
17.class&id参见css书写规范.
css书写规范
1.编码统一为utf-8;
2.协作开发及分工:i会根据各个模块,同时根据页面相似程序,事先写好大体框架文件,分配给前端人员实现内部结构&表现&行为;共 用css文件base.css由i书写,协作开发过程中,每个页面请务必都要引入,此文件包含reset及头部底部样式,此文件不可随意修改;
3.class与id的使用:id是唯一的并是父级的,class是可以重复的并是子级的,所以id仅使用在大的模块上,class可用在重复使用率高及子级中;id原则上都是由我分发框架文件时命名的,为JavaScript预留钩子的除外;
4.为JavaScript预留钩子的命名,请以js_起始,比如:js_hide,js_show;
5.class与id命名:大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式 名称由小写英文&数字&_来组合命名,如i_comment,fontred,width200;避免使用中文拼音,尽量使用简易的单词 组合;总之,命名要语义化,简明化.
6.规避class与id命名(此条重要,若有不明白请及时与i沟通):
a)通过从属写法规避,示例见d;
b)取父级元素id/class命名部分命名,示例见d;
c)重复使用率高的命名,请以自己代号加下划线起始,比如i_clear;
d)a,b两条,适用于在2中已建好框架的页面,如,要在2中已建好框架的页面代码中加入新的div元素
7.css属性书写顺序,建议遵循:布局定位属性–>自身属性–>文本属性–>其他属性.此条可根据自身习惯书写,但尽量保证同类 属性写在一起.属性列举:布局定位属性主要包括:display&list-style&position(相应的 top,right,bottom,left)&float&clear&visibility&overflow;自身属性主要包 括:width&height&margin&padding&border&background;文本属性 主要包括:color&font&text-decoration&text-align&vertical- align&white-space&其他&content;我所列出的这些属性只是最常用到的,并不代表全部;
8.书写代码前,考虑并提高样式重复使用率;
9.充分利用html自身属性及样式继承原理减少代码量,比如:
●这儿是标题列表2012-04-24
定义
ul.listli{position:relative}ul.listlispan{position:absolute;right:0}
即可实现日期居右显示
10.样式表中中文字体名,请务必转码成unicode码,以避免编码错误时乱码;
11.背景图片请尽可能使用sprite技术,减小http请求,考虑到多人协作开发,sprite按模块制作;
12.使用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;}tableth,tabletd{padding:0;},base.css文件中我会初始化表格样式)
13.如何可以请少使用兼容;
14.用png图片做图片时,要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果,请为ie6单独定义背景:
_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop,src=’img/bg.png’);
15.避免兼容性属性的使用,比如text-shadow||css3的相关属性;
16.减少使用影响性能的属性,比如position:absolute||float;
17.必须为大区块样式添加注释,小区块适量注释;
18.代码缩进与格式:建议单行书写,可根据自身习惯,后期优化会统一处理;
JavaScript书写规范
1.文件编码统一为utf-8,书写过程过,每行代码结束必须有分号;原则上所有功能均根据XXX项目需求原生开发,以避免网上down下来的代码造成的代码污染(沉冗代码||与现有代码冲突||…);
2.库引入:原则上仅引入jQuery库,若需引入第三方库,须与团队其他人员讨论决定;
3.变量命名:驼峰式命名.原生JavaScript变量要求是纯英文字母,首字母须小写,如iTaoLun;
jQuery变量要求首字符为’_’,其他与原生JavaScript规则相同,如:_iTaoLun;
另,要求变量集中声明,避免全局变量.
4.类命名:首字母大写,驼峰式命名.如ITaoLun;
5.函数命名:首字母小写驼峰式命名.如iTaoLun();
6.命名语义化,尽可能利用英文单词或其缩写;
7.尽量避免使用存在兼容性及消耗资源的方法或属性,比如eval_r()&innerText;
8.后期优化中,JavaScript非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示;
9.代码结构明了,加适量注释.提高函数重用率;
10.注重与html分离,减小reflow,注重性能.
图片规范
1.所有页面元素类图片均放入img文件夹,测试用图片放于img/demoimg文件夹;
2.图片格式仅限于gif||png||jpg;
3.命名全部用小写英文字母||数字||_的组合,其中不得包含汉字||空格||特殊字符;尽量用易懂的词汇,便于团队其他成员理解;另,命名分头尾两部分,用下划线隔开,比如ad_left01.gif||btn_submit.gif;
4.在保证视觉效果的情况下选择最小的图片格式与图片质量,以减少加载时间;
5.尽量避免使用半透明的png图片(若使用,请参考css规范相关说明);
6.运用csssprite技术集中小的背景图或图标,减小页面http请求,但注意,请务必在对应的spritepsd源图中划参考线,并保存至img目录下.
注释规范
1.html注释:注释格式,‘–’只能在注释的始末位置,不可置入注释文字区域;
2.css注释:注释格式;
3.JavaScript注释,单行注释使用’//这儿是单行注释’,多行注释使用;
开发及测试工具约定
建议使用WebStorm||Aptana||Dw||Vim,亦可根据自己喜好选择,但须遵循如下原则:
1.不可利用IDE的视图模式’画’代码;
2.不可利用IDE生成相关功能代码,比如Dw内置的一些功能js;
3.编码必须格式化,比如缩进;
测试工具:前期开发仅测试FireFox&IE6&IE7&IE8&IE9&Opera&Chrome&Safari;
其他规范
1.开发过程中严格按分工完成页面,以提高css复用率,避免重复开发;
2.减小沉冗代码,书写所有人都可以看的懂的代码.简洁易懂是一种美德.为用户着想,为服务器着想.
文章来源:http://blog.jobbole.com/26961/
Web前端开发规范文档你需要知道的事--HTML、css、js、文档等需要规范内容的更多相关文章
- Web前端开发最佳实践(8):还没有给CSS样式排序?其实你可以更专业一些
前言 CSS样式排序是指按照一定的规则排列CSS样式属性的定义,排序并不会影响CSS样式的功能和性能,只是让代码看起来更加整洁.CSS代码的逻辑性并不强,一般的开发者写CSS样式也很随意,所以如果不借 ...
- Web前端开发实战1:二级下拉式菜单之CSS实现
二级下拉式菜单在各大学校站点.电商类站点.新闻类站点等大型?站点非经常见,那么它的实现原理是什么呢? 学习了Web前端开发的知识后,我们是能够实现这种功能的.复杂的都是从基础效果上加入做出来的.原理和 ...
- 前端开发流程之(线上)绝对地址(图片+css+js)
重要提醒:前端写完-----发邮件通知项目组 1:写好的前段资源包上传到SVN上之后,相关的图片.CSS.js文件要换成线上地址给后台开发. 2:图片-----压缩(https://tinypng.c ...
- Web前端开发最佳实践(7):使用合理的技术方案来构建小图标
大家都对网站上使用的小图标肯定都不陌生,这些小图标作为网站内容的点缀,增加了网站的美观度,提高了用户体验,可是你有没有看过在这些网站中使用的图标都是用什么技术实现的?虽然大部分网站还是使用普通的图片实 ...
- 怎么成为合格的WEB前端开发工程师
web前端开发工程师目前来讲是一个热门职位,但是要成为一个合格的web前端开发工程师,需要掌握的知识可不少,零度就简单的为大家讲讲. 大致的来讲,web前端开发工程师需要掌握的知识有:HTML.CSS ...
- WEB前端开发--2(HTML基础)
HTML基础 HTML不分大小写 1.HTML概述 HTML(HyperText MarkUp Language)"超文本标记语言",他是制作网页的标准语言 1.1 标签--元素 ...
- Web前端开发最佳实践(9):CSS代码太太乱,重复代码太多?你需要精简CSS代码
前言 提高网站整体加载速度的一个重要手段就是提高代码文件的网络传输速度.之前提到过,所有的代码文件都应该是经过压缩了的,这可提高网络传输速度,提高性能.除了压缩代码之外,精简代码也是一种减小代码文件大 ...
- 月薪20k的web前端开发程序员,他们都会的这6招
web前端工程师是近几年的新兴职业,也是目前火爆而且高薪的职业.不同的公司也有不同的叫法,比如:网页界面开发,网站设计等,要学好web前端开发,需要掌握什么方法与技巧? 一.div和table 这个是 ...
- Web前端开发最佳实践系列文章汇总
Web前端开发最佳实践(1):前端开发概述 Web前端开发最佳实践(2):前端代码重构 Web前端开发最佳实践(3):前端代码和资源的压缩与合并 Web前端开发最佳实践(4):在页面中添加必要的met ...
- Web前端开发实战6:CSS实现导航菜单结合二级下拉式菜单的简单变换
前面几篇博文都在讲导航菜单和二级下拉式菜单,事实上有非常多方法都能够实现的.详细的情况还要视情况而定. 在后面学习到jQuery框架之后,会有更丰富的动画效果.因为在学习Ajax和jQuery的初步阶 ...
随机推荐
- 《ASP.NET1200例》在DataList里编辑和删除数据
学习内容:如何创建一个支持编辑和删除数据的DataList.增加编辑和删除功能需要在DataList的ItemTemplate和EditItemTemplate里增加合适的控件,创建对应的事件处理,读 ...
- js init : function ()
这个init外面应该还有一层,比如 var a = { init: function () {...}, exit: function () {...} } 这样的话,可以用a.init()来调用这个 ...
- hdu 1050 Moving Tables 解题报告
题目链接:http://acm.hdu.edu.cn/showproblem.php?pid=1050 这道题目隔了很久才做出来的.一开始把判断走廊有重叠的算法都想错了.以为重叠只要满足,下一次mov ...
- js将map转换成数组
/** * map转数组. * * @param {Map}map * map对象 * @return 数组 */ Share.map2Ary = function(map) { var list = ...
- 安装chocolatey
C:\> @powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.web ...
- Material Design入门
本文主要包括以下内容 ToolBar的使用 RecyclerView的定义与使用 ToolBar 风格 (style) 界面 (layout) 程序 (java) 首先自定义一个theme,并将App ...
- [原]FileHelper-文件操作辅助类
using System; using System.Collections.Generic; using System.IO; using System.Text; namespace Whir.S ...
- jquery+php实现用户输入搜索内容时自动提示
index.html <html> <head> <meta charset=;} #search_auto li a:hover{background:#D8D ...
- [MySQL]命令行工具和基本操作
[MySQL]命令行工具和基本操作 一 MySQL命令行工具 (查看帮助 ---help,或 -?) 1)MySQL MySQL是一个简单的SQL外壳(有GNU readline功能).它支持交互式 ...
- java 输入输出流1 FileInputStrem&&FileOutStream
通过文件输入流读取问价 package unit6; import java.io.FileInputStream; import java.io.FileNotFoundException; imp ...