Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
README.md

README.md

Web前端开发规范文档

规范目的:


  • 使开发流程更加规范化。

通用规范:


  • TAB键用两个空格代替(WINDOWS下TAB键占四个空格,LINUX下TAB键占八个空格)。
  • CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。
  • 文件内容编码均统一为UTF-8
  • CSSJAVASCRIPT中的非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示。

文件规范:


  • 文件名用英文单词,多个单词用驼峰命名法。
  • 一些浏览器会将含有这些词的作为广告拦截,文件命名、ID、CLASS等所有命名避免以上词汇。 adadsadvbannersponsorggguanggguanggao等。

html书写规范:


  • 为每个HTML页面的第一行添加标准模式(standard mode)的声明,确保在每个浏览器中拥有一致的展现。
	<!DOCTYPE html>		
`文档类型声明`统一为HTML5声明类型,`编码`统一为UTF-8。
	<meta charset="UTF-8">
`<HEAD>`中添加信息。
	<meta name="author" content="smile@kang.cool">//作者
	<meta name="description" content="hello">//网页描述
	<meta name="keywords" content="a,b,c">//关键字,“,”分隔
	<meta http-equiv="expires" content="Wed, 26 Feb 1997 08:21:57 GMT">//设定网页的到期时间。一旦网页过期,必须到服务器上重新调阅
	<meta http-equiv="Pragma" content="no-cache">//禁止浏览器从本地机的缓存中调阅页面内容
	<meta http-equiv="Window-target" content="_top">//用来防止别人在框架里调用你的页面
	<meta http-equiv="Refresh" content="5;URL=http://kahn1990.com/">//跳转页面,5指时间停留5秒 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引,哪些页面不需要索引
	<meta name="robots" content="none">//content的参数有all,none,index,noindex,follow,nofollow,默认是all
	<link rel="Shortcut Icon" href="favicon.ico">//收藏图标
	<meta http-equiv="Cache-Control" content="no-cache, must-revalidate">//网页不会被缓存
`IE`支持通过特定&lt;meta&gt;标签来确定绘制当前页面所应该采用的`IE`版本。除非有强烈的特殊需求,否则最好是设置为`edge mode` ,从而通知`IE`采用其所支持的最新的模式。
	<meta http-equiv="X-UA-Compatible" content="IE=Edge">
  • 非特殊情况下CSS样式文件外链至HEAD之间,JAVASCRIPT文件外链至页面底部。
	<!DOCTYPE html>
	<html>
	<head>
		<link rel="stylesheet" href="css/main.css">
	</head>
	<body>
		<!-- 逻辑代码 -->
		<!-- 逻辑代码底部 -->
		<script src="lib/jquery/jquery-2.1.1.min.js"></script>
	</body>
	</html>
引入`JAVASCRIPT`库文件,文件名须包含库名称及版本号及是否为压缩版。
	jQuery-1.8.3.min.js
引入`JAVASCRIPT`插件, 文件名格式为库名称+`.`+插件名称。
	jQuery.cookie.js
  • HTML属性应当按照以下给出的顺序依次排列,来确保代码的易读性。
	class
	id 、 name
	data-*
	src、for、 type、 href
	title、alt
	aria-*、 role
编码均遵循`XHTML`标准,
标签、属性、属性命名由小写英文、数字和\_组成,且所有标签必须闭合,属性值必须用双引号`""`,
避免使用中文拼音尽量简易并要求语义化。
	CLASS --> nHeadTitle --> CLASS遵循小驼峰命名法(little camel-case)
	ID --> n_head_title --> ID遵循名称+_
	NAME --> N_Head_Title --> NAME属性命名遵循首个字母大写+_
	<div class="nHeadTitle" id="n_head_title" name="N_Head_Title"></div>
当`JAVASCRIPT`获取单个元素时,通常使用document.getElementById来获取dom元素,document.getElementById兼容所有浏览器,但IE浏览器会混淆元素的ID和NAME属性,所以要区分ID和NAME命名。
	<input type="text" name="test">
	<div id="test"></div>
	<button onclick="alert(document.getElementById('test').tagName)"></button>
	<!-- ie6下为INPUT -->
  • 特殊符号应使用转意符。
	<    -->    &lt;
	>    -->    &gt;
	空格  -->    &nbsp;
  • 含有描述性表单元素(INPUTTEXTAREA)添加LABEL
	<p>
		<label for="test">测试</label>
		<input type="text" id="test" />
	</p>
  • 多用无兼容性问题的HTML内置标签,比如SPAN、EM、STRONG、OPTGROUP、LABEL等,需要自定义HTML标签属性时,首先考虑是否存在已有的合适标签可替换,如果没有,可使用须以“data-”为前缀来添加自定义属性,避免使用其他命名方式。
  • 语义化HTML
  • 尽可能减少<DIV>嵌套。
  • 书写链接地址时避免重定向。
	href="http://www.kahn1990.com/" //即在URL地址后面加“/”
  • HTML中对于属性的定义,确保全部使用双引号,绝不要使用单引号

css书写规范:


  • 为了欺骗W3C的验证工具,可将代码分为两个文件,一个是针对所有浏览器,一个只针对IE。即将所有符合W3C的代码写到一个文件中,而一些IE中必须而又不能通过W3C验证的代码(如:cursor:hand;)放到另一个文件中,再用下面的方法导入。
	<!-- 放置所有浏览器样式-->
	<link rel="stylesheet" type="text/css" href="">
	<!-- 只放置IE必须,而不能通过w3c的-->
	<!--[if IE]
		<link rel="stylesheet" href="">
	<![endif]-->
  • CSS样式新建或修改尽量遵循以下原则。
	根据新建样式的适用范围分为三级:全站级、产品级、页面级。
	尽量通过继承和层叠重用已有样式。
	不要轻易改动全站级CSS。改动后,要经过全面测试。
  • CSS属性显示顺序。
	显示属性
	元素位置
	元素属性
	元素内容属性
  • CSS书写顺序。
	.header {
	/* 显示属性 */
		display || visibility
		list-style
		position top || right || bottom || left
		z-index
		clear
		float
	/* 自身属性 */
		width max-width || min-width
		height max-height || min-height
		overflow || clip
		margin
		padding
		outline
		border
		background
	/* 文本属性 */
		color
		font
		text-overflow
		text-align
		text-indent
		line-height
		white-space
		vertical-align
		cursor
		content
	};
兼容多个浏览器时,将标准属性写在底部。
	-moz-border-radius: 15px; /* Firefox */
	-webkit-border-radius: 15px; /* Safari和Chrome */
	-o-border-radius: 15px; 
	border-radius: 15px; /* Opera 10.5+, 以及使用了IE-CSS3的IE浏览器 *//标准属性
  • 使用选择器时,命名比较短的词汇或者缩写的不允许直接定义样式。
	.hd,.bd,.td{};//如这些命名
可用上级节点进行限定。
	.recommend-mod .hd
多选择器规则之间换行,即当样式针对多个选择器时每个选择器占一行。
	button.btn,
	input.btn,
	input[type="button"] {…};
优化`CSS`选择器。
	#header a { color: #444; };/*CSS选择器是从右边到左边进行匹配*/
浏览器将检查整个文档中的所有链接和每个链接的父元素,并遍历文档树去查找ID为header的祖先元素,如果找不到header将追溯到文档的根节点,解决方法如下。
	避免使用通配规则和相邻兄弟选择符、子选择符,、后代选择符、属性选择符等选择器
	不要限定id选择符,如div#header(提权的除外)
	不要限定类选择器,如ul.recommend(提权的除外)
	不要使用 ul li a 这样长的选择符
	避免使用标签子选择符,如#header > li > a
  • 使用z-index属性尽量z-index的值不要超过150(通用组的除外),页面中的元素内容的z-index不能超过10(提示框等模块除外但维持在150以下),不允许直接使用(999~9999)之间大值。
  • 尽量避免使用CSS Hack。
	property:value; /* 所有浏览器 */
	+property:value; /* IE7 */
	_property:value; /* IE6 */
	*property:value; /* IE6/7 */
	property:value\9; /* IE6/7/8/9,即所有IE浏览器 */
	* html selector { … }; /* IE6 */
	*:first-child+html selector { … }; /* IE7 */
	html>body selector { … }; /* 非IE6 */
	@-moz-document url-prefix() { … }; /* firefox */
	@media all and (-webkit-min-device-pixel-ratio:0) { … }; /* saf3+/chrome1+ */
	@media all and (-webkit-min-device-pixel-ratio:10000),not all and (-webkit-min-device-pixel-ratio:0) { … }; /* opera */
	@media screen and (max-device-width: 480px) { … }; /* iPhone/mobile webkit */
避免使用低效的选择器。
	body > * {…};
	ul > li > a {…};
	#footer > h3 {…};
	ul#top_blue_nav {…};
	searbar span.submit a { … }; /* 反面示例 */
  • 六个不要三个避免一个使用。
	不要在标签上直接写样式
	不要在CSS中使用expression
	不要在CSS中使用@import
	不要在CSS中使用!important
	不要在CSS中使用“*”选择符
	不要将CSS样式写为单行
	避免使用filter
	避免使用行内(inline)样式
	避免使用“*”设置{margin: 0; padding: 0;}
	使用after或overflow的方式清浮动
  • 减少使用影响性能的属性。
	position:absolute;
	float:left;//如这些定位或浮动属性
	减少在`CSS`中使用滤镜表达式和图片repeat,
	尤其在body当中,渲染性能极差, 如果需要用repeat的话,
	图片的宽或高不能少于8px。

javaScript书写规范:


  • 命名规范。
	常量名
		全部大写并单词间用下划线分隔
		如:CSS_BTN_CLOSE、TXT_LOADING
	对象的属性或方法名
		小驼峰式(little camel-case)
		如:init、bindEvent、updatePosition
		示例:Dialog.prototype = {
				init: function () {},
				bindEvent: function () {},
				updatePosition: function () {}
				 …
			};
	类名(构造器)
		-->小驼峰式但首字母大写
		-->如:Current、DefaultConfig
	函数名
		-->小驼峰式
		-->如:current()、defaultConfig()
	变量名
		-->小驼峰式
		-->如:current、defaultConfig
	私有变量名
		-->小驼峰式但需要用_开头
		-->如:_current、_defaultConfig
	变量名的前缀
		-->续
  • 代码格式。
	"()"前后需要跟空格
	"="前后需要跟空格
	","后面需要跟空格
	JSON对象需格式化对象参数
	if、while、for、do语句的执行体用"{}"括起来
"{}"格式如下。
	if (a==1) {
		//代码
	};
避免额外的逗号。
	var arr = [1,2,3,];
`for-in`循环体中必须用`hasOwnProperty`方法检查成员是否为自身成员,避免来自原型链上的污染。
  • 长语句可考虑断行。
	TEMPL_SONGLIST.replace('{TABLE}', da['results'])
		.replace('{PREV_NUM}', prev)
		.replace('{NEXT_NUM}', next)
		.replace('{CURRENT_NUM}', current)
		.replace('{TOTAL_NUM}', da.page_total);
为了避免和`JSLint`的检验机制冲突,“.”或“+”这类操作符放在行尾。
	TEMPL_SONGLIST.replace('{TABLE}', da['results']).
		replace('{PREV_NUM}', prev).
		replace('{NEXT_NUM}', next).
		replace('{CURRENT_NUM}', current).
		replace('{TOTAL_NUM}', da.page_total);
如果模块代码中,使用其它全局变量想跳过JSLint的检查,可以在该文件中加入`/*global*/`声明。
	/*global alert: true, console: true, top: true, setTimeout: true */
  • 使用严格的条件判断符。用===代替==,用!==代替!=,避免掉入==造成的陷阱 在条件判断时,这样的一些值表示false。
	null
	undefined与null相等
	字符串''
	数字0
	NaN
在==时,则会有一些让人难以理解的陷阱。
	(function () {
		var undefined;
		undefined == null; // true
		1 == true; //true
		2 == true; // false
		0 == false; // true
		0 == ''; // true
		NaN == NaN;// false
		[] == false; // true
		[] == ![]; // true
	})();
对于不同类型的 == 判断,有这样一些规则,顺序自上而下:
	undefined与null相等
	一个是number一个是string时,会尝试将string转换为number
	尝试将boolean转换为number
	0或1
	尝试将Object转换成number或string
而这些取决于另外一个对比量,即值的类型,所以对于0、空字符串的判断,建议使用`===`
。`===`会先判断两边的值类型,类型不匹配时为`false`。
  • 下面类型的对象不建议用new构造。
	new Number
	new String
	new Boolean
	new Object //用{}代替
	new Array //用[]代替
引用对象成员用`obj.prop`代替`obj["prop"]`,除非属性名是变量。
  • 从number到string的转换。
	/** 推荐写法*/
	var a = 1;
	typeof(a); //"number"
	console.log(a); //1
	var aa=a+'';
	typeof(aa); //"string"
	console.log(aa); //'1'
	/** 不推荐写法*/
	new String(a)或a.toString()
从string到number的转换,使用parseInt,必须显式指定第二个参数的进制。
	/** 推荐写法*/
	var a = '1';
	var aa = parseInt(a,10);
	typeof(a); //"string"
	console.log(a); //'1'
	typeof(aa); //"number"
	console.log(aa); //1
从float到integer的转换。
	/** 推荐写法*/
	Math.floor/Math.round/Math.ceil
	/** 不推荐写法*/
	parseInt
字符串拼接应使用数组保存字符串片段,使用时调用join方法。避免使用+或+=的方式拼接较长的字符串,每个字符串都会使用一个小的内存片段,过多的内存片段会影响性能。
	/**推荐的拼接方式array的push、join*/
	var str=[],
		list=['测试A','测试B'];
	for (var i=0 , len=list.length; i < len; i++) {
		str.push( '<div>'+ list[i] + '</div>');
	};
	console.log(str.join('')); //<div>测试A</div><div>测试B</div>
	/** 不推荐的拼接方式+=*/
	var str = '',
		list=['测试A','测试B'];
	for (var i = 0, len = list.length; i< len; i++) {
		str+='<div>' + list[i] + '</div>';
	};
	console.log(str); //<div>测试A</div><div>测试B</div>
  • 尽量避免使用存在兼容性及消耗资源的方法或属性。
	不要使用with,void,evil,eval_r,innerText
  • 注重HTML分离, 减小reflow, 注重性能。

图片规范:


  • 命名应用小写英文数字_组合,便于团队其他成员理解。
	header_btn.gif
	header_btn2.gif
  • 页面元素类图片均放入img文件夹,测试用图片放于img/testimg文件夹,psd源图放入img/psdimg文件夹。
  • 图片格式仅限于gifpngjpg等。
  • png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果,请为ie-6单独定义背景,并尽量避免使用半透明的png图片。
  • 背景图片请尽可能使用sprite技术, 减小http请求。

注释规范:


  • JAVASCRIPTCSS文件注释需要标明作者、文件版本、创建/修改时间、重大版本修改记录、函数描述、文件版本、创建或者修改时间、功能、作者等信息。
	/* * 注释块 */
中间可添加如下信息。
	 @file 文件名
	@addon 把一个函数标记为另一个函数的扩张,另一个函数的定义不在源文件中
	@argument 用大括号中的自变量类型描述一个自变量
	@author 函数/类作者的姓名
	@base 如果类是继承得来,定义提供的类名称
	@class 用来给一个类提供描述,不能用于构造器的文档中
	@constructor 描述一个类的构造器
	@deprecated 表示函数/类已被忽略
	@exception 描述函数/类产生的一个错误
	@exec @extends 表示派生出当前类的另一个类
	@fileoverview 表示文档块将用于描述当前文件,这个标签应该放在其它任何标签之前
	@final 指出函数/类
	@ignore 让jsdoc忽视随后的代码
	@link 类似于@link标签,用于连接许多其它页面
	@member 定义随后的函数为提供的类名称的一个成员
	@param 用大括号中的参数类型描述一个参数
	@private 表示函数/类为私有,不应包含在生成的文档中
	@requires 表示需要另一个函数/类
	@return 描述一个函数的返回值
	@see 连接到另一个函数/类
	@throws 描述函数/类可能产生的错误
	@type 指定函数/成员的返回类型
	@version 函数/类的版本号

开发及测试工具约定:


  • 编码格式化,三码统一。
  • 测试工具: 前期开发仅测试FireFox & IE6 & IE7 & IE8 & IE9 & Opera & Chrome & Safari

参考和借鉴了大家的经验,收集整理了这一篇开发规范,感谢所有的原作者,众人拾柴火焰高,技术无国界,持续更新中。