通用规范:
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)的声明,确保在每个浏览器中拥有一致的展现。
文档类型声明
统一为HTML5声明类型
,编码统一为utf-8
。
<!DOCTYPE html>
<meta charset="UTF-8">
<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">//网页不会被缓存
HTML属性应当按照以下给出的顺序依次排列,来确保代码的易读性。
class
id 、 name
data-*
src、for、 type、 href
title、alt
aria-*、 roleclass
–> 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>
p.s. 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 -->
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中使用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书写规范
"()"前后需要跟空格
"="前后需要跟空格
","后面需要跟空格
JSON对象需格式化对象参数
if、while、for、do语句的执行体用"{}"括起来
长句可采用断行,但为了避免和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 */
从string到number的转换,使用parseInt,必须显式指定第二个参数的进制。
字符串拼接应使用数组保存字符串片段,使用时调用join方法。避免使用+或+=的方式拼接较长的字符串,每个字符串都会使用一个小的内存片段,过多的内存片段会影响性能。
尽量避免使用存在兼容性及消耗资源的方法或属性。
不要使用with,void,evil,eval_r,innerText
注重HTML分离, 减小reflow, 注重性能。
javascript编码规范:
用更合理的方式写 JavaScriptAirbnb JavaScript Style Guide()
中文翻译版