Html和Css编码规范总结

目前创新互联已为上1000+的企业提供了网站建设、域名、虚拟空间、网站托管维护、企业网站设计、伽师网站维护等服务，公司将坚持客户导向、应用为本的策略，正道将秉承"和谐、参与、激情"的文化，与客户和合作伙伴齐心协力一起成长，共同发展。

Html

语法：

l 用两个空格来代替制表符（tab）--这是唯一能保证在所有环境下获得一致展现的方法；

l 嵌套元素应该缩进一次（即两个空格）；

l 对于属性的定义，确保完全使用双引号，绝对不要使用单引号；

l 不要在自闭和（self-closing）元素的尾部添加斜线--Html5规范中明确说明这是可选的；

l 不要省略可选的结束标签（closing tag）（例如：或）。

示例：

Hello, world!

Html5 doctype：

为每个Html页面的第一行添加标准模式（standard mode）的声明，这样能确保在每个浏览器中拥有一致的展现。

示例：











语言属性：

根据Html5规范：

强烈建议为Html根元素制定lang属性，从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音，有助于翻译工具确定其翻译时所应遵守的规则等等。

更多关于lang属性的知识可以从http://www.w3.org/html/wg/drafts/html/master/semantics.html#the-html-element中了解、语言代码表http://reference.sitepoint.com/html/lang-codes

示例：







IE兼容模式：

IE支持通过特定的标签来确定绘制当前页面所应该采用的IE版本。除非有强烈的特殊需求，否则最好是设置为edge mode，从而通知IE采用其所支持的最新的模式。

阅读这篇stack overflow上的文章（http://stackoverflow.com/questions/6771258/whats-the-difference-if-meta-http-equiv-x-ua-compatible-content-ie-edge-e）可以获得更多的信息。

示例：



字符编码：

通过明确声明字符编码，能够确保浏览器快速并容易的判断页面内容的渲染方式。这样做的好处是，可以避免在Html中使用字符实体（character entity）标记，从而全部与文档编码一致（一般采用UTF-8编码）。

示例：







引入Css和JavaScript文件：

根据Html5规范，在引入Css和JavaScript文件时一般不需要指定type属性，因为text/css和text/javascript分别是他们的默认值。

示例：













实用为王：

尽量遵循Html标准和语义，但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度。

属性顺序：

Html属性应当按照以下给出的顺序依次排列，确保代码的易读性。

l class

l id , name

l data-*

l src , for , type , href

l title , alt

l aria-* , role

class用于标识高度可复用组件，因此排在首位。Id用于标识具体组件，应当谨慎使用（例如：页面内的书签），因此排在第二位。

示例：



Example link







布尔（boolean）属性：

布尔型属性可以在声明时不赋值。XHtml规范要求为其赋值，但是Html5规范不需要，更多信息参考WhatWG section on boolean attributes（http://www.whatwg.org/specs/web-apps/current-work/multipage/common-microsyntaxes.html#boolean-attributes）。

元素的布尔型属性如果有值，就是true，如果没有值，就是false。

如果一定要为其赋值的话，请参考WhatWG规范：如果属性存在，其值必须是空字符串或[...]属性的规范名称，并且不要在收尾添加空白符，简单来说，就是不用赋值。

示例：







1



减少标签的数量：

编写Html代码时，尽量避免多余的父元素。很多时候，这需要迭代和重构来实现。

示例：













JavaScript生成的标签：

通过JavaScript生成的标签让内容变得不易查找、编辑。并且降低性能。能避免时尽量避免。

Css

语法：

l 用两个空格来代替制表符（tab）--这是唯一能保证在所有环境下获得一致展现的方法；

l 为选择器分组时，将单独的选择器单独放一行；

l 为了代码的易读性，在每行声明块的左花括号前添加一个空格；

l 声明块的右花括号应当单独成行；

l 每条声明语句的:后应该插入一个空格；

l 为了获得更标准的错误报告，每条声明都应该独占一行；

l 所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的，但是，如果省略这个分号，你的代码可能更容易出错；

l 对于以逗号分隔的属性值，每个逗号后面都应该插入一个空格（例如：box-shadow）；

l 不要在rgb()、rgba()、hsl()、hsla()或rect()值的内部的逗号后面插入空格。这样利于从多个属性值（加逗号也加空格）中区分多个颜色值（只加逗号，不加空格）；

l 对于属性值或颜色参数，省略小于1的小数前面的0（例如：.5代替0.5、-.5px代替-0.5px）；

l 十六进制值应该全部小写，例如：#fff。在描写文档时，小写字符易于分辨，因为他们的形式更易于区分；

l 尽量使用简写形式的十六进制，例如：用#fff替换#ffffff；

l 为选择器的属性添加双引号，例如：input[type=”text”]。只有在某些情况下是可选的（http://mathiasbynens.be/notes/unquoted-attribute-values#css），但是，为了代码的一致性，建议都加上双引号；

l 避免为0值指定单位，例如：用margin:0;代替margin:0px;。

对于此处用到的术语，可参考syntax section of the Cascading Style Sheets article（http://en.wikipedia.org/wiki/Cascading_Style_Sheets#Syntax）。

示例：

/* 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;

}

声明顺序：

相关的属性声明应当归为一组，并按照下面的顺序排列：

1. Positioning；

2. Box model；

3. Typographic；

4. Visual。

由于定位（positioning）可以从正常的文档流中移除元素，并且还能覆盖盒模型（box model）相关的样式，因此排在首位。盒模型排在第二位，因为它决定了组件的尺寸和位置。

其他属性只是影响组件的内部（inside）或者是不影响前两组属性，因此排在后面。

完整的属性列表及其排列顺序请参考Recess（http://twitter.github.com/recess）。

示例：

.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;

}

不要使用@import：

与标签相比，@import指令要慢很多，不光增加了额外的请求次数，还会导致不可预料的问题。替代的办法有以下几种：

l 使用多个元素；

l 通过Sass或Less类似的Css预处理器将多个Css文件便以为一个文件；

l 通过Rails、Jekyll或其他系统中提供过Css文件合并功能。

请参考Steve Souders的文章（http://www.stevesouders.com/blog/2009/04/09/dont-use-import/）了解更多知识。

示例：









媒体查询（Media query）的位置：

将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件中或者放在文档底部。如果你把他们分开了，将来只会被大家遗忘。下面给出一个典型的实例。

示例：

.element { ... }

.element-avatar { ... }

.element-selected { ... }

@media (min-width: 480px) {

.element { ...}

.element-avatar { ... }

.element-selected { ... }

}

带前缀的属性：

当使用特定厂商的带有前缀的属性时，通过缩进的方式，让每个属性的值在垂直方向对齐，这样便于多行编辑。

在 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);

}

单行规则声明：

对于只包含一条声明的样式，为了易读性和快速编辑，建议将语句放在同一行。对于带多条声明的样式，还是应当将声明分为多行。

这样做的关键因素是为了错误检测--例如：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 { background-position: 0 0; }

.icon-home { background-position: 0 -20px; }

.icon-account { background-position: 0 -40px; }

简单形式的属性声明：

在需要显示地设置所有值的情况下，应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下：

l padding；

l margin；

l font；

l background；

l border；

l border-radius。

大部分情况下，我们不需要为简写形式的属性声明指定所有值。例如：Html的heading元素只需要设置上、下边距（margin）的值，因此，在必要的时候，只需要覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱，并且会对属性值带来不必要的覆盖从而引起意外的副作用。

MDN（Mozilla Developer Network）上一片非常好的关于shorthand properties 的文章（https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties），对于不太熟悉简写属性声明及其行为的用户很有用。

示例：

/* 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;

}

Less和Sass中的嵌套：

避免非必要的嵌套。这是因为你虽然可以使用嵌套，但是并不意味着应该使用嵌套。只有在必须将样式限制在父元素内（也就是后代选择器），并且存在多个需要嵌套的元素时才使用嵌套。

示例：

// Without nesting

.table > thead > tr > th { … }

.table > thead > tr > td { … }

// With nesting

.table > thead > tr {

> th { … }

> td { … }

}

注释：

代码是由人编写维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或class名称。

对于较长的注释，务必书写完整的句子；对于一般性的注释，可以书写简洁的短语。

示例：

/* Bad example */

/* Modal header */

.modal-header {

...

}

/* Good example */

/* Wrapping element for .modal-title and .modal-close */

.modal-header {

...

}

class命名：

l class名称中只能出现小写字符和破折号（dashe）（不是下划线，也不是驼峰命名法）。破则好应当用于相关class的命名（类似于命名空间）（例如：.btn和.btn-danger）；

l 避免过度的任意简写。.btn代表button，但是.s不代表任何意思；

l class名称应当尽可能短，并且意义明确；

l 使用有意义的名称。使用有组织的或目的明确的名称，不要使用表现形式（presentational）的名称；

l 基于最近的父class或基本（base）class作为新class的前缀；

l 使用.js-*class来标识行为（与样式相对），并且不要将这些class包含到Css文件中。

在为Sass和Less变量命名时也可以参考上面列出的各项规范。

示例：

/* Bad example */

.t { ... }

.red { ... }

.header { ... }

/* Good example */

.tweet { ... }

.important { ... }

.tweet-header { ... }

选择器：

l 对于通用元素使用class，这样有利于渲染性能的优化；

l 对于经常出现的组件，避免使用属性选择器（例如：[class^=”...”]）。浏览器的性能会受到这些因素的影响；

l 选择器要尽可能短，并且尽量限制组成选择器的元素个数，建议不要超过3；

l 只有在必要的时候才将class限制在最近的父元素内（也就是后代选择器）（例如：不适用带前缀的class时--前缀类似于命名空间）。

扩展阅读：

Scope CSS classes with prefixes（http://markdotto.com/2012/02/16/scope-css-classes-with-prefixes/）

Stop the cascade（http://markdotto.com/2012/03/02/stop-the-cascade/）

示例：

/* Bad example */

span { ... }

.page-container #stream .stream-item .tweet .tweet-header .username { ... }

.avatar { ... }

/* Good example */

.avatar { ... }

.tweet-header .username { ... }

.tweet .avatar { ... }

代码组织：

l 以组件为单位组织代码段；

l 指定一致的注释规范；

l 使用一致的空白符将代码分割成块，这样利于扫描较大的文档；

l 如果使用了多个Css文件，将其按照组件而非页面的形式分拆，因为页面会被重组，而组件只会被移动。

示例：

/*

* Component section heading

*/

.element { ... }

/*

* Component section heading

*

* Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.

*/

.element { ... }

/* Contextual sub-component or modifer */

.element-heading { ... }

编辑器配置：

将你的编辑器按照下面的配置进行设置，以免常见的代码不一致和差异：

l 两个空格代替制表符（soft-tab即用空格代表tab符）；

l 保存文件时，删除尾部的空白符；

l 设置文件编码为UTF-8；

l 在文件的结尾添加一个空白行。

本文标题：前端制作Html和Css编码规范总结
转载来于：http://kswsj.cn/article/sjesep.html