logo资料库

Bootstrap编码规范.docx

第1页 / 共11页
第2页 / 共11页
第3页 / 共11页
第4页 / 共11页
第5页 / 共11页
第6页 / 共11页
第7页 / 共11页
第8页 / 共11页
资料共11页,剩余部分请下载后查看
HTML
CSS
Bootstrap 编码规范:编写灵活、稳定、高质量的 HTML 和 CSS 代码的规范。 黄金定律 永远遵循同一套编码规范 --不管有多少人共同参与同一项目,一定要确保每一 行代码都像是同一个人编写的。 HTML 1、语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展 现的方法。 嵌套元素应当缩进一次(即两个空格)。 对于属性的定义,确保全部使用双引号,绝不要使用单引号。 不要在自闭合(self-closing)元素的尾部添加斜线 --HTML5 规范中明确说明 这是可选的。 不要省略可选的结束标签(closing tag)(例如, 或 )。 示例 Page title ![](images/company-logo.png)

Hello, world!

2、HTML5 doctype 为每个 HTML 页面的第一行添加标准模式(standard mode)的声明,这样能够 确保在每个浏览器中拥有一致的展现。 3、语言属性 根据 HTML5 规范:
强烈建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言。这将有 助于语音合成工具确定其所应该采用的发音,有助于翻译工具确定其翻译时所应 遵守的规则等等。 4、IE 兼容模式 IE 支持通过特定的 标签来确定绘制当前页面所应该采用的 IE 版本。 除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所 支持的最新的模式。 5、字符编码 通过明确声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式。 这样做的好处是,可以避免在 HTML 中使用字符实体标记(character entity), 从而全部与文档编码一致(一般采用 UTF-8 编码)。 6、引入 CSS 和 JavaScript 文件 根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属 性,因为 text/css 和 text/javascript 分别是它们的默认值。 7、实用为王 尽量遵循 HTML 标准和语义,但是不要以牺牲实用性为代价。任何时候都要尽量 使用最少的标签并保持最小的复杂度。 8、属性顺序 HTML 属性应当按照以下给出的顺序依次排列,确保代码的易读性。
class id, name data-* src, for, type, href, value title, alt role, aria-* class 用于标识高度可复用组件,因此应该排在首位。id 用于标识具体组件, 应当谨慎使用(例如,页面内的书签),因此排在第二位。 Example link ![](...) 9、布尔(boolean)型属性 布尔型属性可以在声明时不赋值。XHTML 规范要求为其赋值,但是 HTML5 规范 不需要。 更多信息请参考 WhatWG section on boolean attributes: 元素的布尔型属性如果有值,就是 true,如果没有值,就是 false。 如果一定要为其赋值的话,请参考 WhatWG 规范: 如果属性存在,其值必须是空字符串或 [...] 属性的规范名称,并且不要在首 尾添加空白符。 简单来说,就是不用赋值。 10、减少标签的数量 编写 HTML 代码时,尽量避免多余的父元素。很多时候,这需要迭代和重构来实 现。请看下面的案例: ![](...)
![](...) 11、JavaScript 生成的标签 通过 JavaScript 生成的标签让内容变得不易查找、编辑,并且降低性能。能避 免时尽量避免。 CSS 1、语法 1)用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致 展现的方法。 2)为选择器分组时,将单独的选择器单独放在一行。 3)为了代码的易读性,在每个声明块的左花括号前添加一个空格。 4)声明块的右花括号应当单独成行。 5)每条声明语句的 : 后应该插入一个空格。 6)为了获得更准确的错误报告,每条声明都应该独占一行。 7)所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但 是,如果省略这个分号,你的代码可能更易出错。 8)对于以逗号分隔的属性值,每个逗号后面都应该插入一个空格(例如, box-shadow)。 9)不要在 rgb()、rgba()、hsl()、hsla()或 rect()值的内部的逗号后面插入空 格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号, 不加空格)。 10)对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,.5 代替 0.5;-.5px 代替 -0.5px)。 11)十六进制值应该全部小写,例如,#fff。在扫描文档时,小写字符易于分辨, 因为他们的形式更易于区分。 12)尽量使用简写形式的十六进制值,例如,用 #fff 代替#ffffff。 13)为选择器中的属性添加双引号,例如,input[type="text"]。只有在某些情 况下是可选的,但是,为了代码的一致性,建议都加上双引号。 14)避免为 0 值指定单位,例如,用 margin: 0;代替 margin: 0px;。 /* Bad CSS */ .selector, .selector-secondary, .selector[type=text] { padding:15px; margin:0px 0px 15px; background-color:rgba(0, 0, 0, 0.5); box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF } /* Good CSS */
.selector, .selector-secondary, .selector[type="text"] { padding: 15px; margin-bottom: 15px; background-color: rgba(0,0,0,.5); box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff; } 2、声明顺序 相关的属性声明应当归为一组,并按照下面的顺序排列: Positioning Box model Typographic Visual 由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模 型(box model)相关的样式,因此排在首位。盒模型排在第二位,因为它决定 了组件的尺寸和位置。 其他属性只是影响组件的内部(inside)或者是不影响前两组属性,因此排在后 面。 .declaration-order { /* Positioning */ position: absolute; top: 0; right: 0; bottom: 0; left: 0; z-index: 100; /* Box-model */ display: block; float: right; width: 100px; height: 100px; /* Typography */ font: normal 13px "Helvetica Neue", sans-serif; line-height: 1.5; color: #333; text-align: center; /* Visual */
background-color: #f5f5f5; border: 1px solid #e5e5e5; border-radius: 3px; /* Misc */ opacity: 1; } 3、不要使用 @import 与 标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还 会导致不可预料的问题。替代办法有以下几种: 使用多个 元素 通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件 通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能 4、媒体查询(Media query)的位置 将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件 中或者放在文档底部。如果你把他们分开了,将来只会被大家遗忘。下面给出一 个典型的实例。 .element { ... } .element-avatar { ... } .element-selected { ... } @media (min-width: 480px) { .element { ...} .element-avatar { ... } .element-selected { ... } } 5、带前缀的属性 当使用特定厂商的带有前缀的属性时,通过缩进的方式,让每个属性的值在垂直 方向对齐,这样便于多行编辑。
在 Textmate 中,使用 Text → Edit Each Line in Selection (⌃⌘A)。在 Sublime Text 2 中,使用 Selection → Add Previous Line (⌃⇧↑) 和 Selection → Add Next Line (⌃⇧↓)。 /* Prefixed properties */ .selector { -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15); box-shadow: 0 1px 2px rgba(0,0,0,.15); } 6、单行规则声明 对于只包含一条声明的样式,为了易读性和便于快速编辑,建议将语句放在同一 行。对于带有多条声明的样式,还是应当将声明分为多行。 这样做的关键因素是为了错误检测 -- 例如,CSS 校验器指出在 183 行有语法 错误。如果是单行单条声明,你就不会忽略这个错误;如果是单行多条声明的话, 你就要仔细分析避免漏掉错误了。 /* Single declarations on one line */ .span1 { width: 60px; } .span2 { width: 140px; } .span3 { width: 220px; } /* Multiple declarations, one per line */ .sprite { display: inline-block; width: 16px; height: 15px; background-image: url(../img/sprite.png); } .icon .icon-home .icon-account { background-position: 0 0; } { background-position: 0 -20px; } { background-position: 0 -40px; } 7、简写形式的属性声明 在需要显示地设置所有值的情况下,应当尽量限制使用简写形式的属性声明。常 见的滥用简写属性声明的情况如下: padding margin font background border border-radius
大部分情况下,我们不需要为简写形式的属性声明指定所有值。例如,HTML 的 heading 元素只需要设置上、下边距(margin)的值,因此,在必要的时候,只 需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱,并且会 对属性值带来不必要的覆盖从而引起意外的副作用。 /* Bad example */ .element { margin: 0 0 10px; background: red; background: url("image.jpg"); border-radius: 3px 3px 0 0; } /* Good example */ .element { margin-bottom: 10px; background-color: red; background-image: url("image.jpg"); border-top-left-radius: 3px; border-top-right-radius: 3px; } 8、Less 和 Sass 中的嵌套 避免不必要的嵌套。这是因为虽然你可以使用嵌套,但是并不意味着应该使用嵌 套。只有在必须将样式限制在父元素内(也就是后代选择器),并且存在多个需 要嵌套的元素时才使用嵌套。 // Without nesting .table > thead > tr > th { … } .table > thead > tr > td { … } // With nesting .table > thead > tr { > th { … } > td { … } } 9、Less 和 Sass 中的操作符 为了提高可读性,在圆括号中的数学计算表达式的数值、变量和操作符之间均添 加一个空格。 // Bad example .element { margin: 10px 0 @variable*2 10px; }
分享到:
收藏