HTML編碼規範

時間  2019-11-20
標籤 html 編碼 規範 欄目 HTML 简体版
原文   原文鏈接

 

編碼規範

穩定、高質量的 HTML 和 CSS 代碼的規範。

目錄

HTML

  • HTML5 doctype
  • 語言屬性（Language attribute）
  • 字符編碼
  • IE 兼容模式
  • 引入 CSS 和 JavaScript 文件
  • 實用爲王
  • 屬性順序
  • 布爾（boolean）型屬性
  • 減小標籤的數量
  • JavaScript 生成的標籤

CSS

  • 語法
  • 聲明順序
  • 不要使用 @import
  • 媒體查詢（Media query）的位置
  • 帶前綴的屬性
  • 單行規則聲明
  • 簡寫形式的屬性聲明
  • Less 和 Sass 中的嵌套
  • Less 和 Sass 中的操做符
  • 註釋
  • class 命名
  • 選擇器
  • 代碼組織

黃金定律

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

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

HTML

語法

    • 用兩個空格來代替製表符（tab） – 這是惟一能保證在全部環境下得到一致展示的方法。
      嵌套元素應當縮進一次（即兩個空格）。
    • 對於屬性的定義，確保所有使用雙引號，毫不要使用單引號。
    • 不要在自閉合（self-closing）元素的尾部添加斜線 – HTML5 規範中明確說明這是可選的。
    • 不要省略可選的結束標籤（closing tag）（例如，
      • 或 ）。
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Page title</title>
  5. </head>
  6. <body>
  7. <img src="images/company-logo.png" alt="Company">
  8. <h1 class="hello-world">Hello, world!</h1>
  9. </body>
  10. </html>

HTML5 doctype

      爲每一個 HTML 頁面的第一行添加標準模式（standard mode）的聲明，這樣可以確保在每一個瀏覽器中擁有一致的展示。
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. </head>
  5. </html>

語言屬性

    根據 HTML5 規範：
  • 強烈建議爲 html 根元素指定 lang 屬性，從而爲文檔設置正確的語言。這將有助於語音合成工具肯定其所應該採用的發音，有助於翻譯工具肯定其翻譯時所應遵照的規則等等。
  • 更多關於 lang 屬性的知識能夠從 此規範 中瞭解。
    這裏列出了語言代碼表。
    1. <html lang="en-us">
    2. <!-- ... -->
    3. </html>

    IE 兼容模式

  • IE 支持經過特定的 標籤來肯定繪製當前頁面所應該採用的 IE 版本。除非有強烈的特殊需求，不然最好是設置爲 edge mode，從而通知 IE 採用其所支持的最新的模式。
    閱讀這篇 stack overflow 上的文章能夠得到更多有用的信息。
    1. <meta http-equiv="X-UA-Compatible"
    2. content="IE=Edge">

字符編碼

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

引入 CSS 和 JavaScript 文件

  • 根據 HTML5 規範，在引入 CSS 和 JavaScript 文件時須要指定 type 屬性，由於 text/css 和 text/javascript 分別是它們的默認值 Using link
    Using style
    Using script
  1. <!-- External CSS -->
  2. <link rel="stylesheet" href="code-guide.css">
  4. <!-- In-document CSS -->
  5. <style>
  6. /* ... */
  7. </style>
  9. <!-- JavaScript -->
  10. <script src="code-guide.js"></script>

實用爲王

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

屬性順序

  • HTML 屬性應當按照如下給出的順序依次排列，確保代碼的易讀性。
    class
    id, name
    data-*
    src, for, type, href, value
    title, alt
    role, aria-*
  • class 用於標識高度可複用組件，所以應該排在首位。id 用於標識具體組件，應當謹慎使用（例如，頁面內的書籤），所以排在第二位。
  1. <a class="..." id="..." data-toggle="modal" href="#">
  2. Example link
  3. </a>
  5. <input class="form-control" type="text">
  7. <img src="..." alt="...">

布爾（boolean）型屬性

  • 布爾型屬性能夠在聲明時不賦值。XHTML 規範要求爲其賦值，可是 HTML5 規範不須要。
    更多信息請參考 WhatWG section on boolean attributes

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

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

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

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

  1. <input type="text" disabled>
  3. <input type="checkbox" value="1" checked>
  5. <select>
  6. <option value="1" selected>1</option>
  7. </select>

減小標籤的數量

  • 編寫 HTML 代碼時，儘可能避免多餘的父元素。不少時候，這須要迭代和重構來實現。請看下面的案例：
  1. <!-- Not so great -->
  2. <span class="avatar">
  3. <img src="...">
  4. </span>
  6. <!-- Better -->
  7. <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。git

  1. /* Bad CSS */
  2. .selector, .selector-secondary, .selector[type=text] {
  3. padding:15px;
  4. margin:0px 0px 15px;
  5. background-color:rgba(0, 0, 0, 0.5);
  6. box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF
  7. }
  9. /* Good CSS */
  10. .selector,
  11. .selector-secondary,
  12. .selector[type="text"] {
  13. padding: 15px;
  14. margin-bottom: 15px;
  15. background-color: rgba(0,0,0,.5);
  16. box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff;
  17. }

聲明順序

  • 相關的屬性聲明應當歸爲一組，並按照下面的順序排列：
  1. Positioning
  2. Box model
  3. Typographic
  4. Visual
  • 因爲定位（positioning）能夠從正常的文檔流中移除元素，而且還能覆蓋盒模型（box model）相關的樣式，所以排在首位。盒模型排在第二位，由於它決定了組件的尺寸和位置。
  • 其餘屬性只是影響組件的內部（inside）或者是不影響前兩組屬性，所以排在後面。
  • 完整的屬性列表及其排列順序請參考 Recess。
  1. .declaration-order {
  2. /* Positioning */
  3. position: absolute;
  4. top: 0;
  5. right: 0;
  6. bottom: 0;
  7. left: 0;
  8. z-index: 100;
  10. /* Box-model */
  11. display: block;
  12. float: right;
  13. width: 100px;
  14. height: 100px;
  16. /* Typography */
  17. font: normal 13px "Helvetica Neue", sans-serif;
  18. line-height: 1.5;
  19. color: #333;
  20. text-align: center;
  22. /* Visual */
  23. background-color: #f5f5f5;
  24. border: 1px solid #e5e5e5;
  25. border-radius: 3px;
  27. /* Misc */
  28. opacity: 1;
  29. }

不要使用 @import

  • 與 標籤相比，@import 指令要慢不少，不光增長了額外的請求次數，還會致使不可預料的問題。替代辦法有如下幾種：
    1. 使用多個 <link> 元素
    2. 經過 Sass 或 Less 相似的 CSS 預處理器將多個 CSS 文件編譯爲一個文件
    3. 經過 Rails、Jekyll 或其餘系統中提供過 CSS 文件合併功能
    請參考 Steve Souders的文章 瞭解更多知識。
  1. <!-- Use link elements -->
  2. <link rel="stylesheet" href="core.css">
  4. <!-- Avoid @imports -->
  5. <style>
  6. @import url("more.css");
  7. </style>

媒體查詢（Media query）的位置

  • 將媒體查詢放在儘量相關規則的附近。不要將他們打包放在一個單同樣式文件中或者放在文檔底部。若是你把他們分開了，未來只會被你們遺忘。下面給出一個典型的實例。
  1. .element { ... }
  2. .element-avatar { ... }
  3. .element-selected { ... }
  5. @media (min-width: 480px) {
  6. .element { ...}
  7. .element-avatar { ... }
  8. .element-selected { ... }
  9. }

帶前綴的屬性

  • 當使用特定廠商的帶有前綴的屬性時，經過縮進的方式，讓每一個屬性的值在垂直方向對齊，這樣便於多行編輯。github

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

  1. /* Prefixed properties */
  2. .selector {
  3. -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
  4. box-shadow: 0 1px 2px rgba(0,0,0,.15);
  5. }

單行規則聲明

  • 對於只包含一條聲明的樣式，爲了易讀性和便於快速編輯，建議將語句放在同一行。對於帶有多條聲明的樣式，仍是應當將聲明分爲多行。bootstrap

  • 這樣作的關鍵因素是爲了錯誤檢測 – 例如，CSS 校驗器指出在 183 行有語法錯誤。若是是單行單條聲明，你就不會忽略這個錯誤；若是是單行多條聲明的話，你就要仔細分析避免漏掉錯誤了。瀏覽器

  1. /* Single declarations on one line */
  2. .span1 { width: 60px; }
  3. .span2 { width: 140px; }
  4. .span3 { width: 220px; }
  6. /* Multiple declarations, one per line */
  7. .sprite {
  8. display: inline-block;
  9. width: 16px;
  10. height: 15px;
  11. background-image: url(../img/sprite.png);
  12. }
  13. .icon { background-position: 0 0; }
  14. .icon-home { background-position: 0 -20px; }
  15. .icon-account { background-position: 0 -40px; }

簡寫形式的屬性聲明

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

    1. padding
    2. margin
    3. font
    4. background
    5. border
    6. border-radius

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

  • 在 MDN（Mozilla Developer Network）上一篇很是好的關於shorthand properties 的文章，對於不太熟悉簡寫屬性聲明及其行爲的用戶頗有用。

  1. /* Bad example */
  2. .element {
  3. margin: 0 0 10px;
  4. background: red;
  5. background: url("image.jpg");
  6. border-radius: 3px 3px 0 0;
  7. }
  9. /* Good example */
  10. .element {
  11. margin-bottom: 10px;
  12. background-color: red;
  13. background-image: url("image.jpg");
  14. border-top-left-radius: 3px;
  15. border-top-right-radius: 3px;
  16. }

Less 和 Sass 中的嵌套

  • 避免沒必要要的嵌套。這是由於雖然你可使用嵌套，可是並不意味着應該使用嵌套。只有在必須將樣式限制在父元素內（也就是後代選擇器），而且存在多個須要嵌套的元素時才使用嵌套。
    擴展閱讀：

    Nesting in Sass and Less

  1. // Without nesting
  2. .table > thead > tr > th { … }
  3. .table > thead > tr > td { … }
  5. // With nesting
  6. .table > thead > tr {
  7. > th { … }
  8. > td { … }
  9. }

Less 和 Sass 中的操做符

  • 爲了提升可讀性，在圓括號中的數學計算表達式的數值、變量和操做符之間均添加一個空格。
  1. // Bad example
  2. .element {
  3. margin: 10px 0 @variable*2 10px;
  4. }
  6. // Good example
  7. .element {
  8. margin: 10px 0 (@variable * 2) 10px;
  9. }

註釋

  • 代碼是由人編寫並維護的。請確保你的代碼可以自描述、註釋良好而且易於他人理解。好的代碼註釋可以傳達上下文關係和代碼目的。不要簡單地重申組件或 class 名稱。

  • 對於較長的註釋，務必書寫完整的句子；對於通常性註解，能夠書寫簡潔的短語。

  1. /* Bad example */
  2. /* Modal header */
  3. .modal-header {
  4. ...
  5. }
  7. /* Good example */
  8. /* Wrapping element for .modal-title and .modal-close */
  9. .modal-header {
  10. ...
  11. }

class 命名

  • class 名稱中只能出現小寫字符和破折號（dashe）（不是下劃線，也不是駝峯命名法）。破折號應當用於相關 class 的命名（相似於命名空間）（例如，.btn 和 .btn-danger）。
  • 避免過分任意的簡寫。.btn 表明 button，可是 .s 不能表達任何意思。
  • class 名稱應當儘量短，而且意義明確。
  • 使用有意義的名稱。使用有組織的或目的明確的名稱，不要使用表現形式（presentational）的名稱。
  • 基於最近的父 class 或基本（base） class 做爲新 class 的前綴。
  • 使用 .js-* class 來標識行爲（與樣式相對），而且不要將這些 class 包含到 CSS 文件中。
  • 在爲 Sass 和 Less 變量命名時也能夠參考上面列出的各項規範。
  1. /* Bad example */
  2. .t { ... }
  3. .red { ... }
  4. .header { ... }
  6. /* Good example */
  7. .tweet { ... }
  8. .important { ... }
  9. .tweet-header { ... }

選擇器

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

    Scope CSS classes with prefixes
    Stop the cascade

  1. /* Bad example */
  2. span { ... }
  3. .page-container #stream .stream-item .tweet .tweet-header .username { ... }
  4. .avatar { ... }
  6. /* Good example */
  7. .avatar { ... }
  8. .tweet-header .username { ... }
  9. .tweet .avatar { ... }

代碼組織

  • 以組件爲單位組織代碼段。
  • 制定一致的註釋規範。
  • 使用一致的空白符將代碼分隔成塊，這樣利於掃描較大的文檔。
  • 若是使用了多個 CSS 文件，將其按照組件而非頁面的形式分拆，由於頁面會被重組，而組件只會被移動。
  1. /*
  2. * Component section heading
  3. */
  5. .element { ... }
  8. /*
  9. * Component section heading
  10. *
  11. * Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.
  12. */
  14. .element { ... }
  16. /* Contextual sub-component or modifer */
  17. .element-heading { ... }

編輯器配置

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

    1. 用兩個空格代替製表符（soft-tab 即用空格表明 tab 符）。
    2. 保存文件時，刪除尾部的空白符。
    3. 設置文件編碼爲 UTF-8。
    4. 在文件結尾添加一個空白行。
  • 參照文檔並將這些配置信息添加到項目的 .editorconfig 文件中。例如：Bootstrap 中的 .editorconfig 實例。更多信息請參考 about EditorConfig。
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程