溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

編碼規(guī)范之編寫靈活、穩(wěn)定、高質(zhì)量的 HTML 和 CSS 代

發(fā)布時(shí)間:2020-07-21 02:02:45 來(lái)源:網(wǎng)絡(luò) 閱讀:524 作者:a7272706 欄目:移動(dòng)開發(fā)

管有多少人共同參與同一項(xiàng)目,一定要確保每一行代碼都像是同一個(gè)人編寫的。

因此,編寫靈活、穩(wěn)定、高質(zhì)量的 HTML 和 CSS 代碼,是每一個(gè)技術(shù)人員的基本操守。



HTML


************************************************************************


1、語(yǔ)法

  • 用兩個(gè)空格來(lái)代替制表符(tab) -- 這是唯一能保證在所有環(huán)境下獲得一致展現(xiàn)的方法。

  • 嵌套元素應(yīng)當(dāng)縮進(jìn)一次(即兩個(gè)空格)。

  • 對(duì)于屬性的定義,確保全部使用雙引號(hào),絕不要使用單引號(hào)。

  • 不要在自閉合(self-closing)元素的尾部添加斜線 -- HTML5 規(guī)范中明確說(shuō)明這是可選的。

  • 不要省略可選的結(jié)束標(biāo)簽(closing tag)(例如,</li> 或 </body>)。

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


*********


2、HTML5 doctype

為每個(gè) HTML 頁(yè)面的第一行添加標(biāo)準(zhǔn)模式(standard mode)的聲明,這樣能夠確保在每個(gè)瀏覽器中擁有一致的展現(xiàn)。

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


*********


3、語(yǔ)言屬性

根據(jù) HTML5 規(guī)范:

強(qiáng)烈建議為 html 根元素指定 lang 屬性,從而為文檔設(shè)置正確的語(yǔ)言。這將有助于語(yǔ)音合成工具確定其所應(yīng)該采用的發(fā)音,有助于翻譯工具確定其翻譯時(shí)所應(yīng)遵守的規(guī)則等等。

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

*********


4、IE 兼容模式

IE 支持通過(guò)特定的 <meta> 標(biāo)簽來(lái)確定繪制當(dāng)前頁(yè)面所應(yīng)該采用的 IE 版本。除非有強(qiáng)烈的特殊需求,否則最好是設(shè)置為 edge mode,從而通知 IE 采用其所支持的最新的模式。

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


*********


5、字符編碼

通過(guò)明確聲明字符編碼,能夠確保瀏覽器快速并容易的判斷頁(yè)面內(nèi)容的渲染方式。這樣做的好處是,可以避免在 HTML 中使用字符實(shí)體標(biāo)記(character entity),從而全部與文檔編碼一致(一般采用 UTF-8 編碼)。

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

*********


6、引入 CSS 和 JavaScript 文件

根據(jù) HTML5 規(guī)范,在引入 CSS 和 JavaScript 文件時(shí)一般不需要指定 type 屬性,因?yàn)?code >text/css 和 text/javascript 分別是它們的默認(rèn)值。

<!-- External CSS -->
<link rel="stylesheet" href="code-guide.css">
<!-- In-document CSS -->
<style>
  /* ... */
</style>
<!-- JavaScript -->
<script src="code-guide.js"></script>

*********


7、實(shí)用為王

盡量遵循 HTML 標(biāo)準(zhǔn)和語(yǔ)義,但是不要以犧牲實(shí)用性為代價(jià)。任何時(shí)候都要盡量使用最少的標(biāo)簽并保持最小的復(fù)雜度。


*********


8、屬性順序

HTML 屬性應(yīng)當(dāng)按照以下給出的順序依次排列,確保代碼的易讀性。

  • class

  • idname

  • data-*

  • srcfortypehref

  • titlealt

  • aria-*role

class 用于標(biāo)識(shí)高度可復(fù)用組件,因此應(yīng)該排在首位。id 用于標(biāo)識(shí)具體組件,應(yīng)當(dāng)謹(jǐn)慎使用(例如,頁(yè)面內(nèi)的書簽),因此排在第二位。

<a class="..." id="..." data-modal="toggle" href="#">
  Example link
</a>
<input class="form-control" type="text">
<img src="..." alt="...">


*********


9、布爾(boolean)型屬性

布爾型屬性可以在聲明時(shí)不賦值。XHTML 規(guī)范要求為其賦值,但是 HTML5 規(guī)范不需要。

元素的布爾型屬性如果有值,就是 true,如果沒有值,就是 false。

如果一定要為其賦值的話,請(qǐng)參考 WhatWG 規(guī)范:

如果屬性存在,其值必須是空字符串或 [...] 屬性的規(guī)范名稱,并且不要再收尾添加空白符。

簡(jiǎn)單來(lái)說(shuō),就是不用賦值。

<input type="text" disabled>
<input type="checkbox" value="1" checked>
<select>
  <option value="1" selected>1</option>
</select>

*********


10、減少標(biāo)簽的數(shù)量

編寫 HTML 代碼時(shí),盡量避免多余的父元素。很多時(shí)候,這需要迭代和重構(gòu)來(lái)實(shí)現(xiàn)。

<!-- 糟糕案例 -->
<span class="avatar">
  <img src="...">
</span>
<!-- 最佳方案 -->
<img class="avatar" src="...">

*********


11、JavaScript 生成的標(biāo)簽

通過(guò) JavaScript 生成的標(biāo)簽讓內(nèi)容變得不易查找、編輯,并且降低性能。能避免時(shí)盡量避免。



***************************************************************


CSS


***************************************************************


1、語(yǔ)法

  • 用兩個(gè)空格來(lái)代替制表符(tab) -- 這是唯一能保證在所有環(huán)境下獲得一致展現(xiàn)的方法。

  • 為選擇器分組時(shí),將單獨(dú)的選擇器單獨(dú)放在一行。

  • 為了代碼的易讀性,在每個(gè)聲明塊的左花括號(hào)前添加一個(gè)空格。

  • 聲明塊的右花括號(hào)應(yīng)當(dāng)單獨(dú)成行。

  • 每條聲明語(yǔ)句的 : 后應(yīng)該插入一個(gè)空格。

  • 為了獲得更準(zhǔn)確的錯(cuò)誤報(bào)告,每條聲明都應(yīng)該獨(dú)占一行。

  • 所有聲明語(yǔ)句都應(yīng)當(dāng)以分號(hào)結(jié)尾。最后一條聲明語(yǔ)句后面的分號(hào)是可選的,但是,如果省略這個(gè)分號(hào),你的代碼可能更易出錯(cuò)。

  • 對(duì)于以逗號(hào)分隔的屬性值,每個(gè)逗號(hào)后面都應(yīng)該插入一個(gè)空格(例如,box-shadow)。

  • 不要在 rgb()rgba()、hsl()hsla() 或 rect() 值的內(nèi)部的逗號(hào)后面插入空格。這樣利于從多個(gè)屬性值(既加逗號(hào)也加空格)中區(qū)分多個(gè)顏色值(只加逗號(hào),不加空格)。

  • 對(duì)于屬性值或顏色參數(shù),省略小于 1 的小數(shù)前面的 0 (例如,.5 代替 0.5;-.5px 代替 -0.5px)。

  • 十六進(jìn)制值應(yīng)該全部小寫,例如,#fff。在掃描文檔時(shí),小寫字符易于分辨,因?yàn)樗麄兊男问礁子趨^(qū)分。

  • 盡量使用簡(jiǎn)寫形式的十六進(jìn)制值,例如,用 #fff 代替 #ffffff。

  • 為選擇器中的屬性添加雙引號(hào),例如,input[type="text"]。只有在某些情況下是可選的,但是,為了代碼的一致性,建議都加上雙引號(hào)。

  • 避免為 0 值指定單位,例如,用 margin: 0; 代替 margin: 0px;

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

*********


2、聲明順序

相關(guān)的屬性聲明應(yīng)當(dāng)歸為一組,并按照下面的順序排列:

  1. Positioning

  2. Box model

  3. Typographic

  4. Visual

由于定位(positioning)可以從正常的文檔流中移除元素,并且還能覆蓋盒模型(box model)相關(guān)的樣式,因此排在首位。盒模型排在第二位,因?yàn)樗鼪Q定了組件的尺寸和位置。

其他屬性只是影響組件的內(nèi)部(inside)或者是不影響前兩組屬性,因此排在后面。

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


*********


3、不要使用 @import

與 <link> 標(biāo)簽相比,@import 指令要慢很多,不光增加了額外的請(qǐng)求次數(shù),還會(huì)導(dǎo)致不可預(yù)料的問(wèn)題。替×××法有以下幾種:

  • 使用多個(gè) <link> 元素

  • 通過(guò) Sass 或 Less 類似的 CSS 預(yù)處理器將多個(gè) CSS 文件編譯為一個(gè)文件

  • 通過(guò) Rails、Jekyll 或其他系統(tǒng)中提供過(guò) CSS 文件合并功能

<!-- Use link elements -->
<link rel="stylesheet" href="core.css">
<!-- Avoid @imports -->
<style>
  @import url("more.css");
</style>


*********


4、媒體查詢(Media query)的位置

將媒體查詢放在盡可能相關(guān)規(guī)則的附近。不要將他們打包放在一個(gè)單一樣式文件中或者放在文檔底部。如果你把他們分開了,將來(lái)只會(huì)被大家遺忘。下面給出一個(gè)典型的實(shí)例。

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


*********


5、帶前綴的屬性

當(dāng)使用特定廠商的帶有前綴的屬性時(shí),通過(guò)縮進(jìn)的方式,讓每個(gè)屬性的值在垂直方向?qū)R,這樣便于多行編輯。

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


*********


6、單行規(guī)則聲明

對(duì)于只包含一條聲明的樣式,為了易讀性和便于快速編輯,建議將語(yǔ)句放在同一行。對(duì)于帶有多條聲明的樣式,還是應(yīng)當(dāng)將聲明分為多行。

這樣做的關(guān)鍵因素是為了錯(cuò)誤檢測(cè) -- 例如,CSS 校驗(yàn)器指出在 183 行有語(yǔ)法錯(cuò)誤。如果是單行單條聲明,你就不會(huì)忽略這個(gè)錯(cuò)誤;如果是單行多條聲明的話,你就要仔細(xì)分析避免漏掉錯(cuò)誤了。

/* 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-p_w_picpath: url(../img/sprite.png);
}
.icon           { background-position: 0 0; }
.icon-home      { background-position: 0 -20px; }
.icon-account   { background-position: 0 -40px; }


*********


7、簡(jiǎn)寫形式的屬性聲明

在需要顯示地設(shè)置所有值的情況下,應(yīng)當(dāng)盡量限制使用簡(jiǎn)寫形式的屬性聲明。常見的濫用簡(jiǎn)寫屬性聲明的情況如下:

  • padding

  • margin

  • font

  • background

  • border

  • border-radius

大部分情況下,我們不需要為簡(jiǎn)寫形式的屬性聲明指定所有值。例如,HTML 的 heading 元素只需要設(shè)置上、下邊距(margin)的值,因此,在必要的時(shí)候,只需覆蓋這兩個(gè)值就可以。過(guò)度使用簡(jiǎn)寫形式的屬性聲明會(huì)導(dǎo)致代碼混亂,并且會(huì)對(duì)屬性值帶來(lái)不必要的覆蓋從而引起意外的副作用。這個(gè)問(wèn)題我自身也經(jīng)常犯,大家只能在實(shí)踐中不斷強(qiáng)化意識(shí)了。

/* Bad example */
.element {
  margin: 0 0 10px;
  background: red;
  background: url("p_w_picpath.jpg");
  border-radius: 3px 3px 0 0;
}
/* Good example */
.element {
  margin-bottom: 10px;
  background-color: red;
  background-p_w_picpath: url("p_w_picpath.jpg");
  border-top-left-radius: 3px;
  border-top-right-radius: 3px;
}


*********


8、Less 和 Sass 中的嵌套

避免非必要的嵌套。這是因?yàn)殡m然你可以使用嵌套,但是并不意味著應(yīng)該使用嵌套。只有在必須將樣式限制在父元素內(nèi)(也就是后代選擇器),并且存在多個(gè)需要嵌套的元素時(shí)才使用嵌套。

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

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


*********


9、注釋

代碼是由人編寫并維護(hù)的。請(qǐng)確保你的代碼能夠自描述、注釋良好并且易于他人理解。好的代碼注釋能夠傳達(dá)上下文關(guān)系和代碼目的。不要簡(jiǎn)單地重申組件或 class 名稱。

對(duì)于較長(zhǎng)的注釋,務(wù)必書寫完整的句子;對(duì)于一般性注解,可以書寫簡(jiǎn)潔的短語(yǔ)。

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


*********


10、class 命名

  • class 名稱中只能出現(xiàn)小寫字符和破折號(hào)(dashe)(不是下劃線,也不是駝峰命名法)。破折號(hào)應(yīng)當(dāng)用于相關(guān) class 的命名(類似于命名空間)(例如,.btn 和 .btn-danger)。

  • 避免過(guò)度任意的簡(jiǎn)寫。.btn 代表 button,但是 .s 不能表達(dá)任何意思。

  • class 名稱應(yīng)當(dāng)盡可能短,并且意義明確。

  • 使用有意義的名稱。使用有組織的或目的明確的名稱,不要使用表現(xiàn)形式(presentational)的名稱。

  • 基于最近的父 class 或基本(base) class 作為新 class 的前綴。

  • 使用 .js-* class 來(lái)標(biāo)識(shí)行為(與樣式相對(duì)),并且不要將這些 class 包含到 CSS 文件中。

在為 Sass 和 Less 變量命名是也可以參考上面列出的各項(xiàng)規(guī)范。

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

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


*********


11、選擇器

  • 對(duì)于通用元素使用 class ,這樣利于渲染性能的優(yōu)化。

  • 對(duì)于經(jīng)常出現(xiàn)的組件,避免使用屬性選擇器(例如,[class^="..."])。瀏覽器的性能會(huì)受到這些因素的影響。

  • 選擇器要盡可能短,并且盡量限制組成選擇器的元素個(gè)數(shù),建議不要超過(guò) 3 。

  • 只有在必要的時(shí)候才將 class 限制在最近的父元素內(nèi)(也就是后代選擇器)(例如,不使用帶前綴的 class 時(shí) -- 前綴類似于命名空間)。

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

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


*********


12、代碼組織

  • 以組件為單位組織代碼段。

  • 制定一致的注釋規(guī)范。

  • 使用一致的空白符將代碼分隔成塊,這樣利于掃描較大的文檔。

  • 如果使用了多個(gè) CSS 文件,將其按照組件而非頁(yè)面的形式分拆,因?yàn)轫?yè)面會(huì)被重組,而組件只會(huì)被移動(dòng)。

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


*********


13、編輯器配置

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

  • 用兩個(gè)空格代替制表符(soft-tab 即用空格代表 tab 符)。

  • 保存文件時(shí),刪除尾部的空白符。

  • 設(shè)置文件編碼為 UTF-8。

  • 在文件結(jié)尾添加一個(gè)空白行。




以上內(nèi)容就是我們?nèi)粘G岸碎_發(fā)中的編碼規(guī)范及要求。

天道酬勤,改變自己的陋習(xí),爭(zhēng)做代碼典范。


更多學(xué)習(xí)資料請(qǐng)自行翻閱Teny5590的51博客,

    或加入到達(dá)內(nèi)集團(tuán)技術(shù)培訓(xùn)畢業(yè)班討論QQ群:227252731 


達(dá)內(nèi)學(xué)員獵頭、HR們,入群請(qǐng)按照要求添加備注,否則一律不通過(guò)。

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI