CSS规则javascript
---------------------------------------------css
1 前言html
2 代码风格html5
2.1 文件java
2.2 缩进jquery
2.3 空格git
2.4 行长度github
2.5 选择器web
2.6 属性express
CSS 做为网页样式的描述语言,在百度一直有着普遍的应用。本文档的目标是使 CSS 代码风格保持一致,容易被理解和被维护。
CSS
文件使用无 BOM
的 UTF-8
编码。解释:
UTF-8 编码具备更普遍的适应性。BOM 在使用程序或工具处理文件时可能形成没必要要的干扰。
4
个空格作为一个缩进层级,不容许使用 2
个空格 或 tab
字符。示例:
.selector {
margin: 0;
padding: 0;
}
120
个字符,除非单行不可分割。解释:
常见不可分割的场景为URL超长。
空格
处或 ,
后换行,建议按逻辑分组。示例:
/* 不一样属性值按逻辑分组 */
background:
transparent url(aVeryVeryVeryLongUrlIsPlacedHere)
no-repeat 0 0;
/* 可重复屡次的属性,每次重复一行 */background-image:
url(aVeryVeryVeryLongUrlIsPlacedHere)
url(anotherVeryVeryVeryLongUrlIsPlacedHere);
/* 相似函数的属性值能够根据函数调用的缩进进行 */background-image: -webkit-gradient(
linear,
left bottom,
left top,
color-stop(0.04, rgb(88,94,124)),
color-stop(0.52, rgb(115,123,162))
);
示例:
/* good */.post,.page,.comment {
line-height: 1.5;
}
/* bad */.post, .page, .comment {
line-height: 1.5;
}
>
、+
、~
选择器的两边各保留一个空格。示例:
/* good */main > nav {
padding: 10px;
}
label + input {
margin-left: 5px;
}
input:checked ~ button {
background-color: #69C;
}
/* bad */main>nav {
padding: 10px;
}
label+input {
margin-left: 5px;
}
input:checked~button {
background-color: #69C;
}
解释:
不容许使用单引号,不容许不使用引号。
示例:
/* good */article[character="juliet"] {
voice-family: "Vivien Leigh", victoria, female;
}
/* bad */article[character='juliet'] {
voice-family: "Vivien Leigh", victoria, female;
}
示例:
/* good */.selector {
margin: 0;
padding: 0;
}
/* bad */.selector { margin: 0; padding: 0; }
示例:
/* good */.selector {
margin: 0;
}
/* bad */.selector {
margin: 0
}
id
、class
选择器添加类型选择器进行限定。解释:
在性能和维护性上,都有必定的影响。
示例:
/* good */#error,.danger-message {
font-color: #c00;
}
/* bad */dialog#error,p.danger-message {
font-color: #c00;
}
3
级,位置靠后的限定条件应尽量精确。示例:
/* good */#username input {}.comment .avatar {}
/* bad */.page .header .login #username input {}.comment div * {}
示例:
/* good */.post {
font: 12px/1.5 arial, sans-serif;
}
/* bad */.post {
font-family: arial, sans-serif;
font-size: 12px;
line-height: 1.5;
}
border
/ margin
/ padding
等缩写时,应注意隐含值对实际数值的影响,确实须要设置多个方向的值时才使用缩写。解释:
border
/ margin
/ padding
等缩写会同时设置多个属性的值,容易覆盖不须要覆盖的设定。如某些方向须要继承其余声明的值,则应该分开设置。
示例:
/* centering <article class="page"> horizontally and highlight featured ones */article {
margin: 5px;
border: 1px solid #999;
}
/* good */.page {
margin-right: auto;
margin-left: auto;
}
.featured {
border-color: #69c;
}
/* bad */.page {
margin: 5px auto; /* introducing redundancy */
}
.featured {
border: 1px solid #69c; /* introducing redundancy */
}
解释:
position
/ top
/ right
/ bottom
/ left
/ float
/ display
/ overflow
等border
/ margin
/ padding
/ width
/ height
等font
/ line-height
/ text-align
/ word-wrap
等background
/ color
/ transition
/ list-style
等另外,若是包含 content
属性,应放在最前面。
示例:
.sidebar {
/* formatting model: positioning schemes / offsets / z-indexes / display / ... */
position: absolute;
top: 50px;
left: 0;
overflow-x: hidden;
/* box model: sizes / margins / paddings / borders / ... */
width: 200px;
padding: 5px;
border: 1px solid #ddd;
/* typographic: font / aligns / text styles / ... */
font-size: 14px;
line-height: 20px;
/* visual: colors / shadows / gradients / ... */
background: #f5f5f5;
color: #333;
-webkit-transition: color 1s;
-moz-transition: color 1s;
transition: color 1s;
}
!important
声明。!important
定义样式。解释:
必须注意的是,仅在设计上 确实不容许任何其它场景覆盖样式
时,才使用内联的 !important
样式。一般在第三方环境的应用中使用这种方案。下面的 z-index
章节是其中一个特殊场景的典型样例。
z-index
进行分层,对文档流外绝对定位元素的视觉层级关系进行管理。解释:
同层的多个元素,如多个由用户输入触发的 Dialog,在该层级内使用相同的 z-index
或递增 z-index
。
建议每层包含100个 z-index
来容纳足够的元素,若是每层元素较多,能够调整这个数值。
z-index
指定为 999
。0
。示例:
/* good */
panel {
opacity: .8;
}
/* bad */
panel {
opacity: 0.8;
}
url()
函数中的路径不加引号。示例:
body {
background: url(bg.png);
}
url()
函数中的绝对路径可省去协议名。示例:
body {
background: url(//baidu.com/img/bg.png) no-repeat 0 0;
}
0
时须省略单位。 (也只有长度单位可省)示例:
/* good */body {
padding: 0 5px;
}
/* bad */body {
padding: 0px 5px;
}
示例:
/* good */.success {
background-color: #aca;
}
/* bad */.success {
background-color: #aaccaa;
}
示例:
/* good */.success {
color: #90ee90;
}
/* bad */.success {
color: lightgreen;
}
示例:
/* good */.success {
background-color: #aca;
color: #90ee90;
}
/* good */.success {
background-color: #ACA;
color: #90EE90;
}
/* bad */.success {
background-color: #ACA;
color: #90ee90;
}
解释:
2D 位置初始值为 0% 0%
,但在只有一个方向的值时,另外一个方向的值会被解析为 center。为避免理解上的困扰,应同时给出两个方向的值。background-position属性值的定义
示例:
/* good */body {
background-position: center top; /* 50% 0% */
}
/* bad */body {
background-position: top; /* 50% 0% */
}
font-family
属性中的字体族名称应使用字体的英文 Family Name
,其中若有空格,须放置在引号中。解释:
所谓英文 Family Name,为字体文件的一个元数据,常见名称以下:
字体 |
操做系统 |
Family Name |
宋体 (中易宋体) |
Windows |
SimSun |
黑体 (中易黑体) |
Windows |
SimHei |
微软雅黑 |
Windows |
Microsoft YaHei |
微软正黑 |
Windows |
Microsoft JhengHei |
华文黑体 |
Mac/iOS |
STHeiti |
冬青黑体 |
Mac/iOS |
Hiragino Sans GB |
文泉驿正黑 |
Linux |
WenQuanYi Zen Hei |
文泉驿微米黑 |
Linux |
WenQuanYi Micro Hei |
示例:
h1 {
font-family: "Microsoft YaHei";
}
font-family
按「西文字体在前、中文字体在后」、「效果佳 (质量高/更能知足需求) 的字体在前、效果通常的字体在后」的顺序编写,最后必须指定一个通用字体族( serif
/ sans-serif
)。解释:
更详细说明可参考本文。
示例:
/* Display according to platform */.article {
font-family: Arial, sans-serif;
}
/* Specific for most platforms */h1 {
font-family: "Helvetica Neue", Arial, "Hiragino Sans GB", "WenQuanYi Micro Hei", "Microsoft YaHei", sans-serif;
}
font-family
不区分大小写,但在同一个项目中,一样的 Family Name
大小写必须统一。示例:
/* good */body {
font-family: Arial, sans-serif;
}
h1 {
font-family: Arial, "Microsoft YaHei", sans-serif;
}
/* bad */body {
font-family: arial, sans-serif;
}
h1 {
font-family: Arial, "Microsoft YaHei", sans-serif;
}
12px
。解释:
因为 Windows 的字体渲染机制,小于 12px
的文字显示效果极差、难以辨认。
normal
外的 font-style
。其余平台也应慎用。解释:
因为中文字体没有 italic
风格的实现,全部浏览器下都会 fallback 到 obilique
实现 (自动拟合为斜体),小字号下 (特别是 Windows 下会在小字号下使用点阵字体的状况下) 显示效果差,形成阅读困难。
line-height
在定义文本段落时,应使用数值。解释:
将 line-height
设置为数值,浏览器会基于当前元素设置的 font-size
进行再次计算。在不一样字号的文本段落组合中,能达到较为温馨的行间间隔效果,避免在每一个设置了 font-size
都须要设置 line-height
。
当 line-height
用于控制垂直居中时,仍是应该设置成与容器高度一致。
示例:
.container {
line-height: 1.5;
}
transition
时应指定 transition-property
。示例:
/* good */.box {
transition: color 1s, border-color 1s;
}
/* bad */.box {
transition: all 1s;
}
解释:
见本文,在可能的状况下应选择这样四种变换:
transform: translate(npx, npx);
transform: scale(n);
transform: rotate(ndeg);
opacity: 0..1;
典型的,可使用 translate
来代替 left
做为动画属性。
示例:
/* good */.box {
transition: transform 1s;
}.box:hover {
transform: translate(20px); /* move right for 20px */
}
/* bad */.box {
left: 0;
transition: left 1s;
}.box:hover {
left: 20px; /* move right for 20px */
}
解释:
标准属性放在最后,按冒号对齐方便阅读,也便于在编辑器内进行多行编辑。
示例:
.box {
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
}
hack
时应尽量考虑是否能够采用其余方式解决。解释:
若是能经过合理的 HTML 结构或使用其余的 CSS 定义达到理想的样式,则不该该使用 hack 手段解决问题。一般 hack 会致使维护成本的增长。
选择器 hack
处理兼容性,而非 属性 hack
。解释:
尽可能使用符合 CSS 语法的 selector hack,能够避免一些第三方库没法识别 hack 语法的问题。
示例:
/* IE 7 */*:first-child + html #header {
margin-top: 3px;
padding: 5px;
}
/* IE 6 */* html #header {
margin-top: 5px;
padding: 4px;
}
属性 hack
。示例:
.box {
_display: inline; /* fix double margin */
float: left;
margin-left: 20px;
}
.container {
overflow: hidden;
*zoom: 1; /* triggering hasLayout */
}
Expression
。
HTML 做为描述网页结构的超文本标记语言,在百度一直有着普遍的应用。本文档的目标是使 HTML 代码风格保持一致,容易被理解和被维护。
4
个空格作为一个缩进层级,不容许使用 2
个空格 或 tab
字符。解释: 对于非 HTML 标签之间的缩进,好比 script 或 style 标签内容缩进,与 script 或 style 标签的缩进同级。
示例:
<style>/* 样式内容的第一级缩进与所属的 style 标签对齐 */ul { padding: 0;}</style>
<ul>
<li>first</li>
<li>second</li>
</ul><script>// 脚本代码的第一级缩进与所属的 script 标签对齐require(['app'], function (app) { app.init();});</script>
120
个字符。解释:
过长的代码不容易阅读与维护。可是考虑到 HTML 的特殊性,不作硬性要求。
class
必须单词全字母小写,单词间以 -
分隔。class
必须表明相应模块或部件的内容或功能,不得以样式信息进行命名。示例:
<!-- good -->
<div class="sidebar"></div>
<!-- bad -->
<div class="left"></div>
<!-- good -->
foo').tagName);</script>
示例:
<!-- good -->
<p>Hello StyleGuide!</p>
<!-- bad -->
<P>Hello StyleGuide!</P>
解释:
常见无需自闭合标签有 input
、br
、img
、hr
等。
示例:
<!-- good -->
<input type="text" name="title">
<!-- bad -->
<input type="text" name="title" />
HTML5
中规定容许省略的闭合标签,不容许省略闭合标签。解释:
对代码体积要求很是严苛的场景,能够例外。好比:第三方页面使用的投放系统。
示例:
<!-- good -->
<ul>
<li>first</li>
<li>second</li>
</ul>
<!-- bad -->
<ul>
<li>first
<li>second
</ul>
解释:
好比 div
不得置于 p
中,tbody
必须置于 table
中。
详细的标签嵌套规则参见HTML DTD中的 Elements
定义部分。
解释:
下面是常见标签语义
示例:
<!-- good -->
<p>Esprima serves as an important <strong>building block</strong> for some JavaScript language tools.</p>
<!-- bad -->
<div>Esprima serves as an important <span class="strong">building block</span> for some JavaScript language tools.</div>
解释:
在兼容性容许的状况下应尽可能保持语义正确性。对网格对齐和拉伸性有严格要求的场景容许例外,如多列复杂表单。
示例:
<!-- good -->
<img class="avatar" src="image.png">
<!-- bad -->
<span class="avatar">
<img src="image.png">
</span>
HTML5
的 doctype
来启用标准模式,建议使用大写的 DOCTYPE
。示例:
<!DOCTYPE html>
html
标签上设置正确的 lang
属性。解释:
有助于提升页面的可访问性,如:让语音合成工具肯定其所应该采用的发音,令翻译工具肯定其翻译语言等。
示例:
<html lang="zh-CN">
meta
必须是 head
的第一个直接子元素。解释:
见 HTML5 Charset能用吗 一文。
示例:
<html>
<head>
<meta charset="UTF-8">
......
</head>
<body>
......
</body>
</html>
HTML
文件使用无 BOM
的 UTF-8
编码。解释:
UTF-8
编码具备更普遍的适应性。BOM
在使用程序或工具处理文件时可能形成没必要要的干扰。
CSS
时必须指明 rel="stylesheet"
。示例:
<link rel="stylesheet" href="page.css">
CSS
和 JavaScript
时无须指明 type
属性。解释:
text/css
和 text/javascript
是 type
的默认值。
CSS
中,行为定义放置于外部 JavaScript
中。解释:
结构-样式-行为的代码分离,对于提升代码的可阅读性和维护性都有好处。
head
中引入页面须要的全部 CSS
资源。解释:
在页面渲染的过程当中,新的CSS可能致使元素的样式从新计算和绘制,页面闪烁。
JavaScript
应当放在页面末尾,或采用异步加载。解释:
将 script
放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必要,请遵照此条建议。
示例:
<body>
<!-- a lot of elements --> <script src="init-behavior.js"></script>
</body>
URL
协议部分与页面相同,建议省略协议前缀。解释:
使用 protocol-relative URL
引入 CSS,在 IE7/8
下,会发两次请求。是否使用 protocol-relative URL
应充分考虑页面针对的环境。
示例:
<script src="//s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>
title
标签声明标题。title
必须做为 head
的直接子元素,并紧随 charset
声明以后。解释:
title
中若是包含 ASCII 以外的字符,浏览器须要知道字符编码类型才能进行解码,不然可能致使乱码。
示例:
<head>
<meta charset="UTF-8">
<title>页面标题</title>
</head>
favicon
可访问。解释:
在未指定 favicon 时,大多数浏览器会请求 Web Server 根目录下的 favicon.ico
。为了保证 favicon 可访问,避免 404,必须遵循如下两种方法之一:
favicon.ico
文件。link
指定 favicon。示例:
<link rel="shortcut icon" href="path/to/favicon.ico">
viewport
。解释:
viewport meta tag 能够设置可视区域的宽度和初始缩放大小,避免在移动设备上出现页面展现不正常。
好比,在页面宽度小于 980px
时,若需 iOS 设备友好,应当设置 viewport 的 width
值来适应你的页面宽度。同时由于不一样移动设备分辨率不一样,在设置时,应当使用 device-width
和 device-height
变量。
另外,为了使 viewport 正常工做,在页面内容样式布局设计上也要作相应调整,如避免绝对定位等。关于 viewport 的更多介绍,能够参见 Safari Web Content Guide的介绍
img
的 src
取值为空。延迟加载的图片也要增长默认的 src
。解释:
src
取值为空,会致使部分浏览器从新加载一次当前页面,参考:https://developer.yahoo.com/performance/rules.html#emptysrc
img
添加没必要要的 title
属性。解释:
多余的 title
影响看图体验,而且增长了页面尺寸。
alt
属性。解释:
能够提升图片加载失败时的用户体验。
width
和 height
属性,以免页面抖动。img
标签实现,无下载需求的图片采用 CSS 背景图实现。解释:
img
形式实现,能方便用户下载。label
标签将其与其标题相关联。解释:
有两种方式:
label
内。label
的 for
属性指向控件的 id
。推荐使用第一种,减小没必要要的 id
。若是 DOM 结构不容许直接嵌套,则应使用第二种。
示例:
<label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label>
<label for="username">用户名:</label> <input type="textbox" name="username" id="username">
button
元素时必须指明 type
属性值。解释:
button
元素的默认 type
为 submit
,若是被置于 form
元素中,点击后将致使表单提交。为显示区分其做用方便理解,必须给出 type
属性。
示例:
<button type="submit">提交</button>
<button type="button">取消</button>
HTML5
的浏览器中优先使用 audio
和 video
标签来定义音视频元素。object
标签内部提供指示浏览器不支持该标签的说明。示例:
<object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</object>