編碼規範

時間 2019-11-26

標籤編碼規範欄目字符編碼简体版

原文原文鏈接

轉向前端寫了一段時間CSS之後看到這個，醍醐灌頂。

難怪老是以爲本身的css文件老是亂到不行，每每看起來簡單的一些細節，決定了不少東西。

特此銘記學習。

編碼規範 by @mdo

編寫靈活、穩定、高質量的 HTML 和 CSS 代碼的規範。javascript

黃金定律

永遠遵循同一套編碼規範 -- 能夠是這裏列出的，也能夠是你本身總結的。若是你發現本規範中有任何錯誤，敬請指正。經過 open an issue on GitHub爲本規範添加或貢獻內容。css

無論有多少人共同參與同一項目，必定要確保每一行代碼都像是同一我的編寫的。html

HTML

語法

用兩個空格來代替製表符（tab） -- 這是惟一能保證在全部環境下得到一致展示的方法。
嵌套元素應當縮進一次（即兩個空格）。
對於屬性的定義，確保所有使用雙引號，毫不要使用單引號。
不要在自閉和（self-closing）元素的尾部添加斜線 -- HTML5 規範中明確說明這是可選的。
不要省略可選的結束標籤（closing tag）（例如，</li> 或</body>）。

<!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>

HTML5 doctype

爲每一個 HTML 頁面的第一行添加標準模（standard mode）式的聲明，這樣可以確保在每一個瀏覽器中擁有一致的展示。前端

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

語言屬性

根據 HTML5 規範：html5

強烈建議爲 html 根元素指定 lang 屬性，從而爲文檔設置正確的語言。這將有助於語音合成工具肯定其所應該採用的發音，有助於翻譯工具肯定其翻譯時所應遵照的規則等等。java

更多關於 lang 屬性的知識能夠從此規範中瞭解。git

這裏列出了語言代碼表。github

<html lang="en-us">
  <!-- ... -->
</html>

IE 兼容模式

IE 支持經過特定的 <meta> 標籤來肯定繪製當前頁面所應該採用的 IE 版本。除非有強烈的特殊需求，不然最好是設置爲 edge mode，從而通知 IE 採用其所支持的最新的模式。web

閱讀這篇 stack overflow 上的文章能夠得到更多有用的信息。bootstrap

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

字符編碼

經過明確聲明字符編碼，可以確保瀏覽器快速並容易的判斷頁面內容的渲染方式。這樣作的好處是，能夠避免在 HTML 中使用字符實體標記（character entity），從而所有與文檔編碼一致（通常採用 UTF-8 編碼）。

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

引入 CSS 和 JavaScript 文件

根據 HTML5 規範，在引入 CSS 和 JavaScript 文件時通常不須要指定 type 屬性，由於 text/css 和 text/javascript 分別是它們的默認值。

HTML5 spec links

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

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

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

實用爲王

儘可能遵循 HTML 標準和語義，可是不要以犧牲實用性爲代價。任什麼時候候都要儘可能使用最少的標籤並保持最小的複雜度。

屬性順序

HTML 屬性應當按照如下給出的順序依次排列，確保代碼的易讀性。

class
id, name
data-*
src, for, type, href
title, alt
aria-*, role

class 用於標識高度可複用組件，所以應該排在首位。id 用於標識具體組件，應當謹慎使用（例如，頁面內的書籤），所以排在第二位。

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

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

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

布爾（boolean）型屬性

布爾型屬性能夠在聲明時不賦值。XHTML 規範要求爲其賦值，可是 HTML5 規範不須要。

更多信息請參考 WhatWG section on boolean attributes：

元素的布爾型屬性若是有值，就是 true，若是沒有值，就是 false。

若是必定要爲其賦值的話，請參考 WhatWG 規範：

若是屬性存在，其值必須是空字符串或 [...] 屬性的規範名稱，而且不要再收尾添加空白符。

簡單來講，就是不用賦值。

<input type="text" disabled>

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

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

減小標籤的數量

編寫 HTML 代碼時，儘可能避免多餘的父元素。不少時候，這須要迭代和重構來實現。請看下面的案例：

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

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

JavaScript 生成的標籤

經過 JavaScript 生成的標籤讓內容變得不易查找、編輯，而且下降性能。能避免時儘可能避免。

CSS

語法

用兩個空格來代替製表符（tab） -- 這是惟一能保證在全部環境下得到一致展示的方法。
爲選擇器分組時，將單獨的選擇器單獨放在一行。
爲了代碼的易讀性，在每一個聲明塊的左花括號前添加一個空格。
聲明塊的右花括號應當單獨成行。
每條聲明語句的 : 後應該插入一個空格。
爲了得到更準確的錯誤報告，每條聲明都應該獨佔一行。
全部聲明語句都應當以分號結尾。最後一條聲明語句後面的分號是可選的，可是，若是省略這個分號，你的代碼可能更易出錯。
對於以逗號分隔的屬性值，每一個逗號後面都應該插入一個空格（例如，box-shadow）。
不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的內部的逗號後面插入空格。這樣利於從多個屬性值（既加逗號也加空格）中區分多個顏色值（只加逗號，不加空格）。
對於屬性值或顏色參數，省略小於 1 的小數前面的 0 （例如，.5 代替 0.5；-.5px 代替 -0.5px）。
十六進制值應該所有小寫，例如，#fff。在掃描文檔時，小寫字符易於分辨，由於他們的形式更易於區分。
儘可能使用簡寫形式的十六進制值，例如，用 #fff 代替#ffffff。
爲選擇器中的屬性添加雙引號，例如，input[type="text"]。只有在某些狀況下是可選的，可是，爲了代碼的一致性，建議都加上雙引號。
避免爲 0 值指定單位，例如，用 margin: 0; 代替 margin: 0px;。

對於這裏用到的術語有疑問嗎？請參考 Wikipedia 上的 syntax section of the Cascading Style Sheets article。

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

聲明順序

相關的屬性聲明應當歸爲一組，並按照下面的順序排列：

Positioning
Box model
Typographic
Visual

因爲定位（positioning）能夠從正常的文檔流中移除元素，而且還能覆蓋盒模型（box model）相關的樣式，所以排在首位。盒模型排在第二位，由於它決定了組件的尺寸和位置。

其餘屬性只是影響組件的內部（inside）或者是不影響前兩組屬性，所以排在後面。

完整的屬性列表及其排列順序請參考 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`

與 <link> 標籤相比，@import 指令要慢不少，不光增長了額外的請求次數，還會致使不可預料的問題。替代辦法有如下幾種：

使用多個 <link> 元素
經過 Sass 或 Less 相似的 CSS 預處理器將多個 CSS 文件編譯爲一個文件
經過 Rails、Jekyll 或其餘系統中提供過 CSS 文件合併功能

請參考 Steve Souders 的文章瞭解更多知識。

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

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

媒體查詢（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; }

簡寫形式的屬性聲明

在須要顯示地設置全部值的狀況下，應當儘可能限制使用簡寫形式的屬性聲明。常見的濫用簡寫屬性聲明的狀況以下：

padding
margin
font
background
border
border-radius

大部分狀況下，咱們不須要爲簡寫形式的屬性聲明指定全部值。例如，HTML 的 heading 元素只須要設置上、下邊距（margin）的值，所以，在必要的時候，只需覆蓋這兩個值就能夠。過分使用簡寫形式的屬性聲明會致使代碼混亂，而且會對屬性值帶來沒必要要的覆蓋從而引發意外的反作用。

MDN（Mozilla Developer Network）上一片很是好的關於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 命名

class 名稱中只能出現小寫字符和破折號（dashe）（不是下劃線，也不是駝峯命名法）。破折號應當用於相關 class 的命名（相似於命名空間）（例如，.btn 和 .btn-danger）。
避免過分任意的簡寫。.btn 表明 button，可是 .s 不能表達任何意思。
class 名稱應當儘量短，而且意義明確。
使用有意義的名稱。使用有組織的或目的明確的名稱，不要使用表現形式（presentational）的名稱。
基於最近的父 class 或基本（base） class 做爲新 class 的前綴。
使用 .js-* class 來標識行爲（與樣式相對），而且不要將這些 class 包含到 CSS 文件中。

在爲 Sass 和 Less 變量命名是也能夠參考上面列出的各項規範。

/* Bad example */
.t { ... }
.red { ... }
.header { ... }

/* Good example */
.tweet { ... }
.important { ... }
.tweet-header { ... }

選擇器

對於通用元素使用 class ，這樣利於渲染性能的優化。
對於常常出現的組件，避免使用屬性選擇器（例如，[class^="..."]）。瀏覽器的性能會受到這些因素的影響。
選擇器要儘量短，而且儘可能限制組成選擇器的元素個數，建議不要超過 3 。
只有在必要的時候纔將 class 限制在最近的父元素內（也就是後代選擇器）（例如，不使用帶前綴的 class 時 -- 前綴相似於命名空間）。

擴展閱讀：

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

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

代碼組織

以組件爲單位組織代碼段。
制定一致的註釋規範。
使用一致的空白符將代碼分隔成塊，這樣利於掃描較大的文檔。
若是使用了多個 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 { ... }