其餘規範:
CSS 規範javascript
媒體文件規範css
javascript 規範html
nodeJs 規範vue
vue項目規範java
優秀的項目源碼,即便是多人開發,看代碼也如出一人之手。統一的編碼規範,可以使代碼更易於閱讀,易於理解,易於維護node
統一兩個空格縮進web
HTML 文件必須加上 DOCTYPE 聲明,並統一使用 HTML5 的文檔聲明:chrome
<!DOCTYPE html>
複製代碼
<meta charset="utf-8">
複製代碼
<!-- 頁面關鍵詞 -->
<meta name ="keywords" content =""/>
<!-- 頁面描述 -->
<meta name ="description" content ="">
<!-- 網頁做者 -->
<meta name ="author" content ="">
複製代碼
<meta http-equiv ="X-UA-Compatible" content ="IE = edge,chrome = 1">
複製代碼
<!-- device-width 是指這個設備最理想的 viewport 寬度 -->
<!-- initial-scale=1.0 是指初始化的時候縮放大小是1,也就是不縮放 -->
<!-- user-scalable=0 是指禁止用戶進行縮放 -->
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
複製代碼
<meta name="format-detection" content="telephone=no">
複製代碼
團隊約定:app
pc 端:ide
<meta charset="utf-8">
<meta name="keywords" content="your keywords">
<meta name="description" content="your description">
<meta name="author" content="author,email address">
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
複製代碼
移動端:
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
<meta name="format-detection" content="telephone=no">
複製代碼
html 標籤分爲如下幾類:
團隊約定:
<x-tags>
、<my-element>
和<my-awesome-app>
都是正確的名字,而<tabs>
和<foo_bar>
是不正確的。這樣的限制使得 HTML 解析器能夠分辨那些是標準元素,哪些是自定義元素推薦:
<input type="text">
複製代碼
不推薦:
<input type=text>
<input type='text'>
複製代碼
不要讓非內容信息污染了你的 HTML,打亂了 HTML 結構。能夠使用:before、:after 等僞類元素
推薦:
HTML 代碼
<!-- That is clean markup! -->
<span class="text-box">
See the square next to me?
</span>
複製代碼
CSS 代碼:
/* We use a :before pseudo element to solve the design problem of placing a colored square in front of the text content */
.text-box:before {
content: '';
display: inline-block;
width: 1rem;
height: 1rem;
background-color: red;
}
複製代碼
不推薦:
HTML 代碼:
<!-- We should not introduce an additional element just to solve a design problem -->
<span class="text-box">
<span class="square"></span>
See the square next to me?
</span>
複製代碼
CSS 代碼:
.text-box > .square {
display: inline-block;
width: 1rem;
height: 1rem;
background-color: red;
}
複製代碼
符號 | 描述 | 轉義符 |
---|---|---|
空格 | |
|
< | 小於 | < |
> | 大於 | > |
& | 和 | & |
" | 引號 | " |
使用 type="tel" 而不是 type="number"
<input type="tel">
複製代碼
不須要爲 CSS、JS 指定類型屬性,HTML5 中默認已包含。
推薦:
<link rel="stylesheet" href="" >
<script src=""></script>
複製代碼
不推薦:
<link rel="stylesheet" type="text/css" href="" >
<script type="text/javascript" src="" ></script>
複製代碼
單行註釋
推薦:
<!-- Comment Text -->
<div>...</div>
複製代碼
不推薦:
<div>...</div><!-- Comment Text -->
<div><!-- Comment Text -->
...
</div>
複製代碼
模塊註釋
<!-- S Comment Text -->
表示模塊開始<!-- E Comment Text -->
表示模塊結束,模塊與模塊之間相隔一行<!-- /Comment Text -->
推薦:
<!-- S Comment Text A -->
<div class="mod_a">
<div class="mod_b">
...
</div>
<!-- /mod_b -->
<div class="mod_c">
...
</div>
<!-- /mod_c -->
</div>
<!-- E Comment Text A -->
<!-- S Comment Text D -->
<div class="mod_d">
...
</div>
<!-- E Comment Text D -->
複製代碼
標籤 | 語義 |
---|---|
<p> |
段落 |
<hn> |
標題(h1~h6) |
<ul> |
無序列表 |
<ol> |
有序列表 |
<nav> |
標記導航,僅對文檔中重要的連接羣使用 |
<main> |
頁面主要內容,一個頁面只能使用一次。若是是 web 應用,則包圍其主要功能 |
<article> |
定義外部的內容,其中的內容獨立於文檔的其他部分 |
<section> |
定義文檔中的節(section、區段)。好比章節、頁眉、頁腳或文檔中的其餘部分。 |
<aside> |
定義其所處內容以外的內容。如側欄、文章的一組連接、廣告、友情連接、相關產品列表 |
<header> |
頁眉一般包括網站標誌、主導航、全站連接以及搜索框 |
<footer> |
頁腳,只有當父級是 body 時,纔是整個頁面的頁腳 |
<figure> |
規定獨立的流內容(圖像、圖表、照片、代碼等等)(默認有 40px 左右 margin) |