前端規范 (持續迭代更新)

**不支持HTML標簽 差評~ ** 這里支持

前端規范 by@xxShen


初衷:編寫靈活、穩定、高質量的 HTML 和 CSS 代碼的規范。

目標:不管有多少人共同參與同一項目,一定要確保每一行代碼都像是同一個人編寫的。

定律:遵循同一套編碼規范 -- 可以是這里列出的,也可以是你自己總結的。這個規范里存在爭議和錯誤,歡迎討論和指正。

目錄

HTML

CSS

其他

<span id="htmlType01">語法</span>

  • 用4個空格來代替tab(制表符) -- 這是唯一能保證在所有環境下獲得一致展現的方法。絕大部分的編輯器都可修改tab為4個空格

  • 嵌套元素應該鎖進1次

  • 屬性的定義,確保全部使用雙引號,絕不要使用單引號

  • 不要在自閉合(self-closing)元素的尾部添加斜線。(搜HTML5規范,明確的說)

  • 不要省略可選的結束標簽(closing tag)(舉個栗子,</span> 或 </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>

<span id="htmlType02">HTML基礎設施</span>

  • 文件應以“<!DOCTYPE ......>”首行頂格開始,推薦使用“<!DOCTYPE html>”

  • 必須申明文檔的編碼charset,且與文件本身編碼保持一致,使用UTF-8編碼<meta charset="utf-8"/>

  • 根據頁面內容和需求填寫適當的keywords和description(按需求來,不做強求)

  • 結構、表現、行為三者分離,避免內聯

  • 使用link將css文件引入,并置于head中。

  • 使用script將js文件引入,并置于body底部

  • 強烈建議為 html 根元素指定 <span style="color:#f60;">lang</span> 屬性

  • 根據 HTML5 規范,在引入 CSS 和 JavaScript 文件時一般不需要指定 <span style="color:#f60;">type</span> 屬性,因為 <span style="color:#f60;">text/css</span> 和 <span style="color:#f60;">text/javascript</span> 分別是它們的默認值

  • 遵循 HTML 標準和語義,但是不要以犧牲實用性為代價。任何時候都要盡量使用最少的標簽并保持最小的復雜度

<!DOCTYPE html>
<html lang="zh-CN">
    <head>
        <meta charset="utf-8" />
        <title>才客:好玩的人才眾籌網站</title>
        <meta name="keywords" content="" />
        <meta name="description" content="" />
        <meta name="viewport" content="width=device-width" />
        <link rel="stylesheet" href="css/style.css" />
        <link rel="shortcut icon" href="img/favicon.ico" />
        <link rel="apple-touch-icon" href="img/touchicon.png" />
    </head>
    <body>
        ……
        <script src="js/dome.js"></script>  
    </body>
</html>

<span id="htmlType03">布爾(boolean)型屬性</span>

  • 布爾型屬性可以在聲明時不賦值。XHTML 規范要求為其賦值,但是 HTML5 規范不需要。
    元素的布爾型屬性如果有值,就是 true,如果沒有值,就是 false。如果一定要為其賦值的話,請參考 WhatWG 規范:
    如果屬性存在,其值必須是空字符串或 [...] 屬性的規范名稱,并且不要再收尾添加空白符。
    簡單來說,就是不用賦值

<span id="htmlType04">減少標簽的數量</span>

  • 編寫 HTML 代碼時,盡量避免多余的父元素。很多時候,這需要迭代和重構來實現。請看下面的案例:
<span class="avatar"><!--not good-->
  <img src="...">
</span>

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

<span id="htmlType05">JavaScript 生成的標簽</span>

  • 通過 JavaScript 生成的標簽讓內容變得不易查找、編輯,并且降低性能。能避免時盡量避免。

<span id="cssType01">CSS語法</span>

  • 用4個空格來代替制表符(tab)

  • 為選擇器分組時,將單獨的選擇器單獨放在一行。

  • 為了代碼的易讀性,在每個聲明塊的左花括號前添加一個空格。

  • 聲明塊的右花括號應當單獨成行。

  • 每條聲明語句的 : 后應該插入一個空格。

  • 為了獲得更準確的錯誤報告,每條聲明都應該獨占一行。

  • 所有聲明語句都應當以分號結尾。最后一條聲明語句后面的分號是可選的,但是,如果省略這個分號,你的代碼可能更易出錯。

  • 對于以逗號分隔的屬性值,每個逗號后面都應該插入一個空格(例如,<span style="color:#f60;">box-shadow</span>)。

  • 不要在 <span style="color:#f60;">rgb()</span>、<span style="color:#f60;">rgba()</span>、<span style="color:#f60;">hsl()</span>、<span style="color:#f60;">hsla()</span> 或 <span style="color:#f60;">rect()</span> 值的內部的逗號后面插入空格。這樣利于從多個屬性值(既加逗號也加空格)中區分多個顏色值(只加逗號,不加空格)。

  • 對于屬性值或顏色參數,省略小于 1 的小數前面的 0 (例如,<span style="color:#f60;">.5</span> 代替 <span style="color:#f60;">0.5</span>;<span style="color:#f60;">-.5px</span> 代替 <span style="color:#f60;">-0.5px</span>)。

  • 十六進制值應該全部小寫,例如,#fff。在掃描文檔時,小寫字符易于分辨,因為他們的形式更易于區分。

  • 盡量使用簡寫形式的十六進制值,例如,用 <span style="color:#f60;">#fff</span> 代替 <span style="color:#f60;">#ffffff</span>。

  • 為選擇器中的屬性添加雙引號,例如,<span style="color:#f60;">input[type="text"]</span>。只有在某些情況下是可選的,但是,為了代碼的一致性,建議都加上雙引號。

  • 避免為 0 值指定單位,例如,用 <span style="color:#f60;">margin: 0</span>; 代替 <span style="color:#f60;">margin: 0px</span>;。

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

<span id="cssType02">不要使用 <em style="color:#f60;">@import</em></span>

  • 與 <link> 標簽相比,@import 指令要慢很多,不光增加了額外的請求次數,還會導致不可預料的問題。替代辦法有以下幾種:

    • 使用多個 <link> 元素

    • 通過 Sass 或 Less 類似的 CSS 預處理器將多個 CSS 文件編譯為一個文件

    • 通過 Rails、Jekyll 或其他系統中提供過 CSS 文件合并功能

<span id="cssType03">簡寫形式的屬性聲明 </span>

在需要顯示地設置所有值的情況下,應當盡量限制使用簡寫形式的屬性聲明。常見的濫用簡寫屬性聲明的情況如下:

  • <span style="color:#f60;">padding</span>
  • <span style="color:#f60;">margin</span>
  • <span style="color:#f60;">font</span>
  • <span style="color:#f60;">background</span>
  • <span style="color:#f60;">border</span>
  • <span style="color:#f60;">border-radius</span>

不需要為簡寫形式的屬性聲明指定所有值。例如,HTML 的 heading 元素只需要設置上、下邊距(margin)的值,因此,在必要的時候,只需覆蓋這兩個值就可以。過度使用簡寫形式的屬性聲明會導致代碼混亂,并且會對屬性值帶來不必要的覆蓋從而引起意外的副作用。

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

<span id="cssType04">注釋</span>

代碼是由人編寫并維護的。請確保你的代碼能夠自描述、注釋良好并且易于他人理解。好的代碼注釋能夠傳達上下文關系和代碼目的。不要簡單地重申組件或 class 名稱。

對于較長的注釋,務必書寫完整的句子;對于一般性注解,可以書寫簡潔的短語。

/* Bad example */
/* Modal header */
.modal-header {
  ...
}

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

<span id="cssType05">class 命名</span>

  • class 名稱中只能出現小寫字符駝峰法(不是下劃線,也不是破折號)。破折號應當用于相關 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 { ... }
.tweetHeader { ... }

<span id="cssType06">選擇器</span>

  • 對于通用元素使用 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 { ... }

<span id="otherType01">編輯器配置</span>

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

  • 用4個空格代替制表符(soft-tab 即用空格代表 tab 符)。
  • 保存文件時,刪除尾部的空白符。
  • 設置文件編碼為 UTF-8。
  • 在文件結尾添加一個空白行。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,881評論 18 139
  • 什么是html? html是一種網頁標記語言,叫超文本標記語言,我們平時上網所看到的所有網頁均來自于html,英文...
    波段頂底閱讀 8,410評論 2 7
  • CSS基礎 本文包括CSS基礎知識選擇器(重要!!!)繼承、特殊性、層疊、重要性CSS格式化排版單位和值盒模型浮動...
    廖少少閱讀 3,172評論 0 40
  • 像謝娜在舞臺上一樣快樂。 曾幾何時,我也笑的那么快樂,那種快樂是在眼睛里都可以看出來的。 現在的眼里,除了悲傷憂愁...
    起伏的身影還是很入戲閱讀 447評論 0 2
  • 夢想是成人世界的奢侈品,于是,我只敢和我的兒子們一起暢談夢想。 問四歲兒子夢想是什么?他很認真地想了想說:“媽媽,...
    莊心愛寫作閱讀 211評論 0 1