寫給初學者的HTML和CSS編碼規范

TML配置

文件應以“”首行頂格開始，推薦使用“”。
必須申明文檔的編碼charset，并且使用UTF-8編碼。
移動端必須使用 viewport 適配
頁面title是極為重要的不可缺少的一項。

以下是一個標準的html結構

html復制代碼<!DOCTYPE html>
<html>
  <head>
    <!-- 必須聲明 utf-8 編碼格式 -->
    <meta charset="utf-8">
    <!-- 頁面標題不能為空 -->
    <title>京東商城:商家后臺</title>
    <!-- 移動端必須使用 viewport 適配需要, PC 看場景需要使用 -->
    <meta name="viewport" content="width=device-width,initial-scale=1.0,user-scalable=no">
     
    <!-- 樣式文件 以外鏈形式在此處引入 -->
    <link href="//static.360buyimg.com/bus/test/shop1_3/UI2.0update.css" rel="stylesheet">
  </head>
  <body>
    <!-- 頁面主體 -->
    <div class="warp">
      <header>頂部內容區域，比如：菜單頭</header>
      <div class="content">主內容區域</div>
      <footer>頂部頁尾區域，比如：備案號</footer>
    </div>
     
    <!-- js文件 在此處引入 -->
    <script type="text/javascript" src="//wl.jd.com/joya.js"></script>
  </body>
</html>

主框架(jQuery,vue,react,angular等) 避免混合使用

避免多個框架混合使用，在同一個工程里面要保持主框架的一致性，多框架同時使用會造成代碼混亂，后期會變得越來越難維護。

Css開發規范

1、全局樣式禁止使用!important

2、避免使用導入式引入css樣式文件；

css復制代碼<style type="text/css">
  @import url(./demo.css);
</style>

未使用的js/css禁止引用

歷史頁面會有一些功能下線，在去除頁面初始化的js語句的同時，也要將依賴的js文件刪除，避免資源加載浪費

文件必須使用gzip壓縮

開啟Gzip壓縮功能，可以使網站的css、js 、xml、html 文件在傳輸時進行壓縮，提高訪問速度

api接口中，無用字段占傳輸比例30%以上時，刪除無用字段

在開發過程中，發現無用字段占傳輸比例30%以上時，請進行返回數據的刪減，加快數據請求速度

關于圖片壓縮

上傳圖片之前一定要做圖片的無損壓縮，節省網絡流量,推薦網站tinypng

HTML的標準結構

html復制代碼<!DOCTYPE html>
<html>
  <head>
    <!-- 必須聲明 utf-8 編碼格式 -->
    <meta charset="utf-8">
    <!-- keywords 關鍵詞 和 Description 頁面描述 便于搜索引擎檢索，不強制使用 -->
    <meta name="Keywords" Content=”關鍵詞1,關鍵詞2,關鍵詞3,關鍵詞4″>
    <meta name="Description" Content=”頁面描述″>
    <!-- 移動端必須使用 viewport 適配需要, PC 看場景需要使用 -->
    <meta name="viewport" content="width=device-width,initial-scale=1.0,user-scalable=no">
    <!-- 推薦手動引入指定路徑 favicon  -->
    <link rel="shortcut icon" href="path/to/favicon.ico">
    <!-- 樣式文件必須以外鏈形式在此處引入 -->
    <link href="//static.360buyimg.com/bus/test/shop1_3/UI2.0update.css" rel="stylesheet">
    <!-- 內聯樣式 -->
    <style type="text/css">
      .warp {
        margin: 0;
        padding: 0;
      }
    </style> -->
    <!-- 頁面標題不能為空 -->
    <title>頁面標題</title>
  </head>
  <body>
  <!-- 頁面主體 -->
    <div class="warp">
    <header>頂部內容區域，比如：菜單頭</header>
    <div class="content">主內容區域</div>
    <footer>頂部頁尾區域，比如：備案號</footer>
    </div>
 
    <!-- JavaScript 文件在此處引入 -->
    <script type="text/javascript" src="//wl.jd.com/joya.js"></script>
  </body>
</html>

不同模塊區域可使用簡要備注標識模塊內容
HTML 標簽語義化使結構清晰，比如：
CSS 外鏈引入必須放在中
JS 外鏈引入必須放在中
省略圖像、媒體文件、樣式表和腳本等嵌入式資源 URL 協議頭部聲明 ( http:// , https:// )，用//代替。
favicon 在未指定 favicon 時，大多數瀏覽器會請求 Web Server 根目錄下的 favicon.ico 。為了保證 favicon 可訪問，避免404，必須遵循以下兩種方法之一：1。在 Web Server 根目錄放置 favicon.ico 文件，2。使用 link 指定 favicon

HTML標簽使用守則

標簽小寫

原生 HTML 標簽元素小寫使用，自定義組件使用小駝峰命名（自定義標簽避免和原生標簽同名）

html復制代碼<!-- 錯誤 ? -->
<DIV></DIV>
<SPAN></SPAN>  
 
<!-- 正確 ? -->
<div></div>  
<p></p> 
 
<!-- 自定義組件 -->
<shareDialog><shareDialog/>

套用規則

禁止在行內元素中嵌套塊級元素??

html復制代碼<!-- 錯誤的嵌套 ? -->
<span><div></div></span>  
<i><p></p></i>     
 
<!-- 正確的嵌套 ? -->
<div><span></span></div>  
<p><i></i></p>

更多標簽使用規則介紹請查看尾部附錄

屬性定義

定義屬性賦值時，使用雙引號，禁止單雙引號混用

html復制代碼<!-- 錯誤的定義 ? -->
<input id="formTitle" type='text' placeholder="請輸入標題">   
 
<!-- 正確的定義 ? -->
<input id="formTitle" type="text" placeholder="請輸入標題" data="formTitle">

正確閉合

除自閉合標簽外，所有標簽都需正確的編寫閉合標簽

常用自閉合標簽： <br />、<col />、<img />、<input />、<link />、<meta />、<keygen />

ID、Class 命名使用規范

ID 和 Class 取通用且有意義的名字；

使用連字符 - 作為 ID、Class 名稱界定符，不要駝峰命名法和下劃線；

避免選擇器嵌套層級過多，盡量少于 3 級；

使用命名空間防止命名沖突，利于維護；

css復制代碼/* 不推薦: 無意義 不易理解 */
#yee-1901 {}
#meunBtn {}
.login_input {}
 
/* 推薦: 明確詳細 */
#gallery {}
#login {}
.login-input {}
.meun-btn {}

避免選擇器和 Class、ID 疊加使用
聲明順序，相關屬性應為一組，建議遵循：定位布局屬性 -> 盒模型屬性 -> 文本屬性 -> 視覺屬性 -> 其他屬性
對于 JS 操作相關選擇器前面需加上特殊應用標識前綴

css復制代碼/* 標準的聲明順序 */
.declaration-order {
  /* 布局屬性 */
  position: absolute;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  z-index: 100;
 
  /* 盒模型屬性 */
  display: block;
  box-sizing: border-box;
  width: 100px;
  height: 100px;
  padding: 10px;
  border: 1px solid #e5e5e5;
  border-radius: 3px;
  margin: 10px;
  float: right;
  overflow: hidden;
 
  /* 文本屬性 */
  font: normal 13px "Helvetica Neue", sans-serif;
  line-height: 1.5;
  text-align: center;
 
  /* 視覺屬性 */
  background-color: #f5f5f5;
  color: #fff;
  opacity: .8;
 
  /* 其他屬性 */
  cursor: pointer;
}

圖片相關使用規范

<img/>標簽守則

src 屬性不能為空，需添加默認值（托底圖片路徑）
為重要圖片添加 alt 屬性，當無法顯示圖像時，瀏覽器將顯示替代文本，便于 SEO 及用戶閱讀
為圖片標簽增加 width 和 height 屬性，避免圖片加載從無到有，導致頁面抖動
大量圖片流資源，使用懶加載技術按需加載

html復制代碼<!-- 禁止 src 取值為空 -->
<img src="" />
 
<!-- 推薦 -->
<img src="xxxx" alt="xxx" style="width:100px;height:100px;" />

圖片資源守則

大小

尺寸小于 50 ×?50 的請使用字體圖標（iconfont）或者將多個圖標合成一張大圖使用（雪碧圖）尺寸大于 50 ×?50 的圖片，引入前先使用在線壓縮對其進行壓縮，圖片大小盡量控制在 300kb 以內

倍率

PC端、移動端推薦使用 2倍圖 (@2x），避免設備分辨率過高，圖片顯示失真模糊如有兼容 iPad 場景等特殊場景，可使用 3倍圖（@3x）

html復制代碼<img src="//logo@200x200.jpg" alt="xx" style="width:100px;height:100px;"/>

2倍圖：圖片展示區域大小 : 圖片實際尺寸 = 1 ：2

無論使用幾倍圖，圖片大小都需遵守上條限制

如遇圖片倍圖問題，可咨詢 @UI童鞋

性能守則

避免不必要的 DOM 操作瀏覽器遍歷 DOM 元素的代價是昂貴的。最簡單優化 DOM 樹查詢的方案是，當一個元素出現多次時，將它保存在一個變量中，來避免多次查詢 DOM 樹。

js復制代碼/* 推薦用變量保存頻繁使用的 DOM 元素*/
var ul = document.getElementsByTagName('ul')[0],
  lis = document.getElementsByTagName('ul')[0].getElementsByTagName('p')
   
/* 推薦用變量保存頻繁使用的 DOM 元素*/
var ul = document.getElementsByTagName('ul')[0],
  lis = ul.getElementsByTagName('li')

異步加載第三方內容當你無法保證嵌入第三方內容比如埋點、調研等資源正常工作的時候，你需要考慮用異步加載這些代碼，避免阻塞整個頁面加載。
減少標簽的數量編寫 HTML 代碼時，盡量避免多余的標簽嵌套，避免 DOM樹的冗余
控制靜態資源數量

1個頁面中建議CSS文件不要超過3個（1個組件庫樣式文件、1個項目公共樣式、1個頁面樣式）； JS文件不要超過5個（1個框架文件、1個組件庫文件、1個項目公共庫文件、1個頁面腳本文件、1個埋點文件）。

編碼建議

縮進使用 2個空格樣式建議引入 CSS reset 重置各瀏覽器自帶樣式差異 github.com/necolas/nor… JS 中字符串定義使用 '' 單引號

其他建議

保持一定的代碼潔癖，尤其在大型項目中

代碼邏輯應當直截了當，清晰易讀，保持與業務邏輯與代碼一一對應關系，減少邏輯錯誤的可能性，降低二次開發成本；
刪除過期無用代碼，減少代碼過大，造成不必要的維護成本
代碼盡量復用，擁有組件化思想
代碼命名合理化，即使不寫注釋情況下，也可以讓其他開發人員一眼明白意思
性能調至最優，降低耦合度，避免別人做不合理的優化時而造成的混亂
整潔的模塊邊界，明確的劃分模塊之間的邏輯邊界，盡量保證職責單一，避免功能交叉混雜
讓代碼沒有改進的余地，在開發時把各種情況都想到了，如果有人企圖改進它，總是會回到原點

性能檢測工具 - Lighthouse簡介 Lighthouse是一個Google開源的自動化工具，主要用于改進網絡應用的質量。Lighthouse會對各個測試項的結果打分，并給出優化建議，這些打分標準和優化建議可以視為Google的網頁最佳實踐。

Chrome拓展程序谷歌商店安裝lighthouse后，在右上角或者菜單里點擊圖中圖標，Options可以配置測試項目，點擊Generate report即可測試。

命令行

js復制代碼<!-- 安裝 lighthouse 組件（Node.js V5.0 或以上版本） -->
npm install -g lighthouse
<!-- 啟動測試 （測試過程中會自動打開 Chrome 完成后會在當前目錄生成一個靜態HTML文件） -->
lighthouse https://www.baidu.com/ --view
<!-- 幫助-->
lighthouse --help

檢測結果

【附錄】常用的標簽規范

標簽	語義	嵌套常見錯誤	常用屬性
<a></a>	超鏈接/錨	a不可嵌套a	href,name,title,rel,target
<div></div>	塊級容器
<p></p>	段落	不能嵌套塊級元素
<span></span>	內聯容器（行內元素）	不可嵌套塊級容器
<form></form>	表單		action,target,method,name
<input />	輸入框	不可嵌套元素	type,name,value,checked,disabled,maxlength,readonly,accesskey
<textarea></textarea>	多行文本輸入控件		name,accesskey,disabled,readonly,rows,cols
<img />	圖像	不可嵌套元素	alt,src,width,height
<label></label>	標簽（常用input元素定義標注）	不可嵌套塊級容器	for
<table></table>	表格	只可嵌套表格子元素	width,align,background,cellpadding,cellspacing,summary,border
<tbody></tbody>	表格主體	只能嵌套在table內
<thead></thead>	表頭	只能嵌套在table內
<tr></tr>	表格行	嵌套于table或thead、tbody、tfoot
<td></td>	表格中的單元格	只用于tr	colspan,rowspan
<th></th>	表格中的標題單元格	只用于tr	colspan,rowspan
<tfoot></tfoot>	表格表尾	只用于table
<button></button>	按鈕	不可嵌套表單、表格等塊級元素	type,disabled
<select></select>	列表框或下拉框	只能嵌套option或optgroup	name,disabled,multiple
<option></option>	select中的一個選項	只能嵌套在select內	value,selected,disabled
<ol></ol>	有序列表	只能嵌套li
<ul></ul>	無序列表	只能嵌套li
<li></li>	無序列表項	只能嵌套在 ul 或 ol 內
<iframe></iframe>	內嵌一個網頁		frameborder,width,height,src,scrolling,name
<br />	換行
<link />	引用樣式或icon	不可嵌套任何元素	type,rel,href
<meta />	文檔信息	只用于head內	content,http-equiv,name
<script></script>	引用腳本	不可嵌套任何元素	type,src
<style></style>	引用樣式	不可嵌套任何元素	type,media
<title></title>	文檔標題	只用于head內

點贊收藏支持、手留余香、與有榮焉，動動你發財的小手喲，感謝各位大佬能留下您的足跡。

作者：StriveToY
鏈接：https://juejin.cn/post/7262378982255394873

ublime / vscode 快捷生成HTML代碼的實現

文章目錄

1.基本html結構

2.生成div加類名的快捷鍵

3.帶類名的div

4.帶id的div

5.屬性【】

6.后代>

7.兄弟+

8.上級^

9.乘法*

10.文本{}

1、基本html結構

操作：輸入 !+Enter鍵

注意：這里輸入“！”+回車鍵前，需要清空原來生成的基本結構

實現效果：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
     
</body>
</html>

2、生成div加類名的快捷鍵

操作：輸入 div.list>div.item_$*6

實現效果：

<div class="list">
    <div class="item_1"></div>
    <div class="item_2"></div>
    <div class="item_3"></div>
    <div class="item_4"></div>
    <div class="item_5"></div>
    <div class="item_6"></div>
</div>

3、帶類名的div

操作：輸入 div.wrapper

實現效果：

<div class="wrapper"></div>

4、帶id的div

操作： div#wrapper

實現效果：

<div id="wrapper"></div>

5、屬性 []

操作： span[title=“test”]

實現效果：

<span title="test"></span>

6、后代 >

操作：輸入div>span>a

實現效果：

<span title="test"></span>

7、兄弟 +

操作： div+p+span

實現效果：

<div></div>
<p></p>
<span></span>

8、上級 ^

操作： div>span^i

實現效果：

<div><span></span></div>
<i></i>

9、乘法 *

操作： ul>li*2

實現效果：

<ul>
    <li></li>
    <li></li>
</ul>

10、文本 {}

操作： div>span{這是文本}

實現效果：

<div><span>這是文本</span></div>

編程領域，代碼規范是非常重要的，因為它們有助于確保代碼的清晰性、一致性和可維護性。不同的編程語言和組織可能有不同的代碼規范，但以下是一些在各種編程語言中普遍認為最常用的代碼規范：

1. PEP 8：針對Python語言的官方風格指南，它提供了Python代碼的編寫標準，包括命名約定、代碼布局、注釋等。

2. Google Python Style Guide：Google為其Python代碼制定了一套風格指南，它基于PEP 8，但在某些方面提供了更具體的指導。

3. Airbnb JavaScript Style Guide：Airbnb為JavaScript編寫了一套風格指南，它被廣泛使用于JavaScript社區，包括ES5和ES6+的規則。

4. Prettier：Prettier是一個代碼格式化工具，它支持多種編程語言，并提供了一套嚴格的代碼風格規則，以保持代碼的一致性。

5. ESLint：ESLint是一個用于JavaScript和JSX的代碼質量工具，它允許開發者定義自己的代碼規范，并幫助檢測代碼中的潛在問題。

6. Ruby Style Guide：由GitHub提供的Ruby風格指南，它涵蓋了Ruby編程語言的編碼習慣和最佳實踐。

7. Scala Style Guide：由Twitter工程師編寫的Scala風格指南，它提供了一套用于Scala編程語言的編碼規范。

8. CSS Guidelines：Harry Roberts編寫的CSS指南，它提供了一套關于如何編寫可維護、可擴展和可管理的CSS的規則。

9. HTML/CSS/JS Coding Conventions：由Google提供的針對HTML、CSS和JavaScript的編碼約定。

10. The Rust Programming Language：Rust官方文檔中包含了Rust編程語言的風格指南。

這些代碼規范通常包括以下幾個方面：

- 命名約定：如何命名變量、函數、類等。

- 代碼布局：如何縮進、空格、換行等。

- 注釋和文檔：如何編寫清晰、有用的注釋和文檔。

- 錯誤處理：如何處理異常和錯誤。

- 代碼組織：如何組織文件和模塊。

遵守這些規范可以幫助團隊更好地協作，并使新加入的成員更容易理解現有代碼。此外，許多代碼規范也被集成到了IDE和編輯器中，以及自動化工具中，如代碼格式化器、靜態分析工具和持續集成系統，以幫助開發者自動遵守這些規范。

在線咨詢

上一篇：CSS 按鈕
下一篇：把HTML網頁下載為單文件，可離線訪問

您的項目需求

*請認真填寫需求信息，我們會在24小時內與您取得聯系。

整合營銷服務商

寫給初學者的HTML和CSS編碼規范

TML配置

主框架(jQuery,vue,react,angular等) 避免混合使用

Css開發規范

未使用的js/css禁止引用

文件必須使用gzip壓縮

api接口中，無用字段占傳輸比例30%以上時，刪除無用字段

關于圖片壓縮

HTML的標準結構

HTML標簽使用守則

標簽小寫

套用規則

屬性定義

正確閉合

ID、Class 命名使用規范

圖片相關使用規范

圖片資源守則

大小

倍率

性能守則

編碼建議

其他建議

【附錄】常用的標簽規范

ublime / vscode 快捷生成HTML代碼的實現

文章目錄

1、基本html結構

操作： 輸入 !+Enter鍵

實現效果：

2、生成div加類名的快捷鍵

操作： 輸入 div.list>div.item_$*6

實現效果：

3、帶類名的div

操作： 輸入 div.wrapper

實現效果：

4、帶id的div

操作： div#wrapper

實現效果：

5、屬性 []

操作： span[title=“test”]

實現效果：

6、后代 >

操作： 輸入div>span>a

實現效果：

7、兄弟 +

操作： div+p+span

實現效果：

8、上級 ^

操作： div>span^i

實現效果：

9、乘法 *

操作： ul>li*2

實現效果：

10、文本 {}

操作： div>span{這是文本}

實現效果：

您的項目需求

操作：輸入 !+Enter鍵

操作：輸入 div.list>div.item_$*6

操作：輸入 div.wrapper

操作：輸入div>span>a