Web前端开辟范例文档
范例目标：
使开辟流程越发范例化。
通用范例：
TAB键用两个空格替代（
WINDOWS下TAB键占四个空格，LINUX下TAB键占八个空格）。
CSS款式属性或许JAVASCRIPT代码后加“;”随意马虎压缩东西“断句”。文件内容编码均一致为
UTF-8。
CSS、JAVASCRIPT中的非解释类中文字符须转换成unicode编码运用，以防备编码毛病时乱码显现。
文件范例：
文件名用英文单词，多个单词用驼峰定名法。
一些浏览器会将含有这些词的作为广告阻拦，文件定名、ID、CLASS等一切定名防备以上辞汇。
`ad`、`ads`、`adv`、`banner`、`sponsor`、`gg`、`guangg`、`guanggao`等
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支撑经由过程特定<meta>标签来肯定绘制当前页面所应该采纳的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 -->
特别符号应运用转意符。
< --> <
> --> >
空格 -->
含有形貌性表单元素（
INPUT，TEXTAREA）增加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; /* Opera 10.5+
运用选择器时，定名比较短的辞汇或许缩写的不允许直接定义款式。
.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文件夹。图片花样仅限于
gif、png、jpg等。用
png图片做图片时,要求图片花样为png-8花样,若png-8着实影响图片质量或其中有半透明结果,请为ie-6零丁定义背景，并只管防备运用半透明的png图片。背景图片请只管运用
sprite手艺, 减小http要求。
解释范例：
JAVASCRIPT、CSS文件解释须要标明作者、文件版本、建立/修正时候、严重版本修正纪录、函数形貌、文件版本、建立或许修正时候、功用、作者等信息。
/* * 解释块 */
中心可增加以下信息。
@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
