HTML CSS編碼規範(黃金定律)

来源:http://www.cnblogs.com/zhengyanbin2016/archive/2016/10/22/5987049.html
-Advertisement-
Play Games

HTML 語法 用兩個空格來代替製表符（tab） -- 這是唯一能保證在所有環境下獲得一致展現的方法。 嵌套元素應當縮進一次（即兩個空格）。 對於屬性的定義，確保全部使用雙引號，絕不要使用單引號。 不要在自閉合（self-closing）元素的尾部添加斜線 --HTML5 規範中明確說明這是可選的。... ...


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 規範：

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

更多關於 lang 屬性的知識可以從 此規範 中瞭解。

這裡列出了語言代碼表。

<html lang="zh-CN">
  <!-- ... -->
</html>
IE 相容模式

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

閱讀這篇 stack overflow 上的文章可以獲得更多有用的信息。

<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;
}
聲明順序

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

  1. Positioning
  2. Box model
  3. Typographic
  4. 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 { ... }
編輯器配置

將你的編輯器按照下麵的配置進行設置，以避免常見的代碼不一致和差異：

  • 用兩個空格代替製表符（soft-tab 即用空格代表 tab 符）。
  • 保存文件時，刪除尾部的空白符。
  • 設置文件編碼為 UTF-8。
  • 在文件結尾添加一個空白行。

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • js動態綁定click事件時function傳參問題
    今天碰到了這樣一個問題，我在javascript中動態創建了一個button， 然後我想給改button添加click事件，綁定的function想要傳入一個變數參數， 一開始我想直接通過函數傳參傳進來，然而不知道為什麼，click事件無法正常響應， 最後發現可以這麼做，將需要傳入的參數加入butt ...
  • jquery插件開發
    今天周六，玩了一上午lol了，趁等飯點的時間淺談一下jquery插件開發，望大神指教鞭策！ 在軟體開發過程中需要一定的設計模式來指導開發，有了模式，我們便能更好的組織我們的代碼，並從前人的經驗中學到更好的實踐。根據《jQuery高級編程》中的描述，jQuery插件開發方式重要有三種： 通常我們使用第 ...
  • ES5——函數，對象，方法，this
    JS由表達式和語句組成 表達式：計算出一個值，但並不進行任何操作，不改變電腦運行狀態 語句：包括 聲明語句，賦值語句，控制結構 函數，對象，方法，this 數組和對象：是兩個非常重要的數據類型 函數：是帶有名稱和參數，可被多次調用的代碼段,函數也是對象，所以函數也是數據類型 函數可以作為方法和構造 ...
  • 求子串-KPM模式匹配-NFA／DFA
    求子串 數據結構中對串的5種最小操作子集：串賦值，串比較，求串長，串連接，求子串，其他操作均可在該子集上實現 數據結構中串的模式匹配 數據結構中串的模式匹配 KPM模式匹配演算法 基本的模式匹配演算法 看的出來，每當匹配不成功時，i總是回朔本次匹配的開始位置KPM，一種改進了的模式匹配演算法，解決i回朔問 ...
  • 數據交互 - Ajax初體驗
    2016-10-22 12:22:42 相關概念 AJAX（Asynchronous Javascript And XML）即“非同步JavaScript和XML”； 是指一種實現客戶端和伺服器的數據傳遞的網頁開發技術； 核心：局部刷新，非同步載入； 即“在不需要刷新頁面的情況下，就可以與Web伺服器交 ...
  • IndexedDB:瀏覽器里內置的資料庫(轉)
    IndexedDB是HTML5規範里新出現的瀏覽器里內置的資料庫。對於在瀏覽器里存儲數據，你可以使用cookies或local storage，但它們都是比較簡單的技術，而IndexedDB提供了類似資料庫風格的數據存儲和使用方式。存儲在IndexedDB里的數據是永久保存，不像cookies那樣只 ...
  • sass中出現的中文問題
    在這園子里看到了很多優秀的資源，自己也想寫寫東西，就突然想到了以前遇到寫sass的時候出現中文亂碼的解決方案。所有就自己又總結了一下。(以下測試步驟都是自己完成的！沒有任何轉載，如有錯誤，希望大家指正) 簡單說明下：sass來編寫css樣式方便了很多，讓我們本來沒有邏輯處理能力的css語法，在sas ...
  • 《理解 ES6》閱讀整理：函數（Functions）（四）Arrow Functions
    箭頭函數（Arrow Functions） 就像名字所說那樣，箭頭函數使用箭頭（=>）來定義函數。與傳統函數相比，箭頭函數在多個地方表現不一樣。 箭頭函數語法（Arrow Function Syntax） 箭頭函數有多種實現方法。比如你想實現一個只有一個參數並且直接返回此參數值的函數： 上面的例子中 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類