HTML CSS coding standards (golden rules)-HTML Tutorial-php.cn

HTML

Syntax

Use two spaces instead of tabs - this is the only way to ensure consistent presentation in all environments. </li>
Nested elements should be indented once (i.e. two spaces). </li>
For attribute definitions, make sure to use double quotes and never single quotes. </li>
Don’t add a trailing slash to a self-closing element -- the HTML5 specification clearly states that this is optional. </li>
Don’t omit the optional closing tag (for example, </li> or </body>). </li>

<code><!DOCTYPE html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    <img src="images/company-logo.png" alt="Company">
    <h1 class="hello-world">Hello, world!</h1>
  </body>
</html>
</code>

Copy after login

HTML5 doctype

Add a standard mode declaration to the first line of each HTML page to ensure consistent display in each browser.

<code><!DOCTYPE html>
<html>
  <head>
  </head>
</html>
</code>

Copy after login

Language properties

According to HTML5 specification:

It is highly recommended to specify the lang attribute for the html root element to set the correct language for the document. This will help speech synthesis tools determine the pronunciation they should use, help translation tools determine the rules they should follow when translating, and so on.

More knowledge about lang attributes can be learned from this specification.

The language code table is listed here.

<code><html lang="zh-CN">
  <!-- ... -->
</html>
</code>

Copy after login

IE Compatibility Mode

IE supports specific <meta> tags to determine the IE version that should be used to draw the current page. Unless there are strong special needs, it is best to set it to edge mode to notify IE to adopt the latest mode it supports.

Read this article on stack overflow for more useful information.

<code><meta http-equiv="X-UA-Compatible" content="IE=Edge">
</code>

Copy after login

Character encoding

By explicitly declaring the character encoding, you can ensure that the browser quickly and easily determines how the page content is rendered. The advantage of this is that you can avoid using character entities in HTML, so that everything is consistent with the document encoding (usually UTF-8 encoding).

<code><head>
  <meta charset="UTF-8">
</head>
</code>

Copy after login

Introduce CSS and JavaScript files

According to the HTML5 specification, there is generally no need to specify the type attribute when introducing CSS and JavaScript files, because text/css and text/javascript are their default values respectively.

HTML5 spec links

Using link </li>
Using style </li>
Using script</li>

<code><!-- External CSS -->
<link rel="stylesheet" href="code-guide.css">

<!-- In-document CSS -->
<style>
  /* ... */
</style>

<!-- JavaScript -->
<script src="code-guide.js"></script>
</code>

Copy after login

Practicality is king

Try to follow HTML standards and semantics, but don’t sacrifice practicality. Try to use the fewest tags and keep complexity to a minimum at all times.

Attribute order

HTML attributes should be arranged in the order given below to ensure the readability of the code.

class </li>
id, name </li>
data-* </li>
src, for, type, href </li>
title, alt </li>
aria-*, role </li>

class is used to identify highly reusable components, so it should be listed first. The id is used to identify a specific component and should be used with caution (for example, bookmarks within a page), so it comes second.

<code><a class="..." id="..." data-modal="toggle" href="#">
  Example link
</a>

<input class="form-control" type="text">

<img src="..." alt="...">
</code>

Copy after login

Boolean properties

Boolean properties can be declared without assigning a value. The XHTML specification requires it to be assigned a value, but the HTML5 specification does not.

For more information, please refer to WhatWG section on boolean attributes:

If the Boolean attribute of the element has a value, it is true; if it has no value, it is false.

If must be assigned a value, please refer to the WhatWG specification:

If the attribute exists, its value must be an empty string or [...] The canonical name of the attribute, and do not add trailing whitespace characters.

To put it simply, there is no need to assign a value.

<code><input type="text" disabled>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>
</code>

Copy after login

Reduce the number of tags

When writing HTML code, try to avoid redundant parent elements. Many times, this requires iteration and refactoring to achieve. Please see the case below:

<code><!-- Not so great -->
<span class="avatar">
  <img src="...">
</span>

<!-- Better -->
<img class="avatar" src="...">
</code>

Copy after login

JavaScript generated tags

Tags generated through JavaScript make content difficult to find, edit, and reduce performance. Avoid it when you can.

CSS

语法

用两个空格来代替制表符（tab） -- 这是唯一能保证在所有环境下获得一致展现的方法。 </li>
为选择器分组时，将单独的选择器单独放在一行。 </li>
为了代码的易读性，在每个声明块的左花括号前添加一个空格。 </li>
声明块的右花括号应当单独成行。 </li>
每条声明语句的 : 后应该插入一个空格。 </li>
为了获得更准确的错误报告，每条声明都应该独占一行。 </li>
所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的，但是，如果省略这个分号，你的代码可能更易出错。 </li>
对于以逗号分隔的属性值，每个逗号后面都应该插入一个空格（例如，box-shadow）。 </li>
不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值（既加逗号也加空格）中区分多个颜色值（只加逗号，不加空格）。 </li>
对于属性值或颜色参数，省略小于 1 的小数前面的 0 （例如，.5 代替 0.5；-.5px 代替 -0.5px）。 </li>
十六进制值应该全部小写，例如，#fff。在扫描文档时，小写字符易于分辨，因为他们的形式更易于区分。 </li>
尽量使用简写形式的十六进制值，例如，用 #fff 代替#ffffff。 </li>
为选择器中的属性添加双引号，例如，input[type="text"]。只有在某些情况下是可选的，但是，为了代码的一致性，建议都加上双引号。 </li>
避免为 0 值指定单位，例如，用 margin: 0; 代替margin: 0px;。</li>

对于这里用到的术语有疑问吗？请参考 Wikipedia 上的 syntax section of the Cascading Style Sheets article。

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

Copy after login

声明顺序

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

Positioning </li>
Box model </li>
Typographic </li>
Visual</li>

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

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

完整的属性列表及其排列顺序请参考 Recess。

<code>.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;
}
</code>

Copy after login

不要使用 `@import`

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

使用多个 <link> 元素 </li>
通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件 </li>
通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能</li>

请参考 Steve Souders 的文章了解更多知识。

<code><!-- Use link elements -->
<link rel="stylesheet" href="core.css">

<!-- Avoid @imports -->
<style>
  @import url("more.css");
</style>
</code>

Copy after login

媒体查询（Media query）的位置

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

<code>.element { ... }
.element-avatar { ... }
.element-selected { ... }

@media (min-width: 480px) {
  .element { ...}
  .element-avatar { ... }
  .element-selected { ... }
}
</code>

Copy after login

带前缀的属性

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

在 Textmate 中，使用 Text → Edit Each Line in Selection(⌃⌘A)。在 Sublime Text 2 中，使用 Selection → Add Previous Line (⌃⇧↑) 和 Selection → Add Next Line (⌃⇧↓)。

<code>/* Prefixed properties */
.selector {
  -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
          box-shadow: 0 1px 2px rgba(0,0,0,.15);
}
</code>

Copy after login

单行规则声明

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

这样做的关键因素是为了错误检测 -- 例如，CSS 校验器指出在 183 行有语法错误。如果是单行单条声明，你就不会忽略这个错误；如果是单行多条声明的话，你就要仔细分析避免漏掉错误了。

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

Copy after login

简写形式的属性声明

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

padding </li>
margin </li>
font </li>
background </li>
border </li>
border-radius</li>

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

MDN（Mozilla Developer Network）上一片非常好的关于shorthand properties 的文章，对于不太熟悉简写属性声明及其行为的用户很有用。

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

Copy after login

Less 和 Sass 中的嵌套

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

<code>// Without nesting
.table > thead > tr > th { … }
.table > thead > tr > td { … }

// With nesting
.table > thead > tr {
  > th { … }
  > td { … }
}
</code>

Copy after login

注释

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

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

<code>/* Bad example */
/* Modal header */
.modal-header {
  ...
}

/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  ...
}
</code>

Copy after login

class 命名

class 名称中只能出现小写字符和破折号（dashe）（不是下划线，也不是驼峰命名法）。破折号应当用于相关 class 的命名（类似于命名空间）（例如，.btn 和 .btn-danger）。 </li>
避免过度任意的简写。.btn 代表 button，但是 .s 不能表达任何意思。 </li>
class 名称应当尽可能短，并且意义明确。 </li>
使用有意义的名称。使用有组织的或目的明确的名称，不要使用表现形式（presentational）的名称。 </li>
基于最近的父 class 或基本（base） class 作为新 class 的前缀。 </li>
使用 .js-* class 来标识行为（与样式相对），并且不要将这些 class 包含到 CSS 文件中。</li>

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

<code>/* Bad example */
.t { ... }
.red { ... }
.header { ... }

/* Good example */
.tweet { ... }
.important { ... }
.tweet-header { ... }
</code>

Copy after login

选择器

对于通用元素使用 class ，这样利于渲染性能的优化。 </li>
对于经常出现的组件，避免使用属性选择器（例如，[class^="..."]）。浏览器的性能会受到这些因素的影响。 </li>
选择器要尽可能短，并且尽量限制组成选择器的元素个数，建议不要超过 3 。 </li>
只有在必要的时候才将 class 限制在最近的父元素内（也就是后代选择器）（例如，不使用带前缀的 class 时 -- 前缀类似于命名空间）。</li>

扩展阅读：

Scope CSS classes with prefixes </li>
Stop the cascade</li>

<code>/* Bad example */
span { ... }
.page-container #stream .stream-item .tweet .tweet-header .username { ... }
.avatar { ... }

/* Good example */
.avatar { ... }
.tweet-header .username { ... }
.tweet .avatar { ... }
</code>

Copy after login

代码组织

以组件为单位组织代码段。 </li>
制定一致的注释规范。 </li>
使用一致的空白符将代码分隔成块，这样利于扫描较大的文档。 </li>
如果使用了多个 CSS 文件，将其按照组件而非页面的形式分拆，因为页面会被重组，而组件只会被移动。</li>

<code>/*
 * 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 { ... }
</code>

Copy after login