程式碼規範的意義在於提供一個參照物。這裡提供了一份全域性的規範,但是你也得參照公司內部的規範,否則閱讀你程式碼的人會很痛苦。這篇文章定義了 HTML 和 CSS 的格式和程式碼規範,旨在提高程式碼質量和協作效率。一起來看看谷歌HTML/CSS規範吧!
通用樣式規範
協議
省略圖片、樣式、指令碼以及其他媒體檔案 URL 的協議部分(http:,https:),除非檔案在兩種協議下都不可用。這種方案稱為 protocol-relative URL,好處是無論你是使用 HTTPS 還是 HTTP 訪問頁面,瀏覽器都會以相同的協議請求頁面中的資源,同時可以節省一部分位元組。
<!-- Not recommended -->
<script src=""></script>
<!-- Recommended -->
<script src="//"></script>
/* Not recommended */
ple {
background: url("");
}
/* Recommended */
ple {
background: url("//");
}
通用格式規範
縮排
一次縮排2個空格,不要使用 tab 或者混合 tab 和空格的縮排。
<ul>
<li>Fantastic
<li>Great
</ul>
ple {
color: blue;
}
大小寫
以下都應該用小寫:HTML 元素名稱,屬性,屬性值(除非 text/CDATA),CSS 選擇器,屬性,屬性值。
<!-- Not recommended -->
<A HREF="/">Home</A>
<!-- Recommended -->
<img src="google.png" alt="Google">
/* Not recommended */
color: #E5E5E5;
/* Recommended */
color: #e5e5e5;
結尾空格
結尾空格不僅多餘,而且在比較程式碼時會更麻煩。
<!-- Not recommended -->
<p>What?_
<!-- Recommended -->
<p>Yes please.
通用元規範
編碼
在 HTML 中通過 <meta charset="utf-8"> 指定編碼方式,CSS 中不需要指定,因為預設是 UTF-8。
註釋
使用註釋來解釋程式碼:包含的模組,功能以及優點。
任務項
用 TODO 來標記待辦事項,而不是用一些其他的標記,像 @@。
<!-- TODO: remove optional tags -->
<ul>
<li>Apples</li>
<li>Oranges</li>
</ul>
HTML風格規範
文件型別
HTML 文件應使用 HTML5 的文件型別:<!DOCTYPE html>。
孤立標籤無需封閉自身,<br> 不要寫成 <br />。
HTML 正確性
儘可能使用正確的 HTML。
<!-- Not recommended -->
<title>Test</title>
<article>This is only a test.
<!-- Recommended -->
<!DOCTYPE html>
<meta charset="utf-8">
<title>Test</title>
<article>This is only a test.</article>
語義化
根據使用場景選擇正確的 HTML 元素(有時被錯誤的稱為“標籤”)。例如,使用 h1 元素建立標題,p 元素建立段落,a 元素建立連結等等。正確的使用 HTML 元素對於可訪問性、可重用性以及編碼效率都很重要。
<!-- Not recommended -->
<p onclick="goToRecommendations();">All recommendations</p>
<!-- Recommended -->
<a href="recommendations/">All recommendations</a>
多媒體元素降級
對於像圖片、視訊、canvas 動畫等多媒體元素,確保提供其他可訪問的內容。圖片可以使用替代文字(alt),視訊和音訊可以使用文字版本。
<!-- Not recommended -->
<img src="spreadsheet.png">
<!-- Recommended -->
<img src="spreadsheet.png" alt="Spreadsheet screenshot.">
關注分離
標記、樣式和指令碼分離,確保相互耦合最小化。
實體引用
如果團隊中文件和編輯器使用同樣的編碼方式,就沒必要使用實體引用,如 —, ”,☺,除了一些在 HTML 中有特殊含義的字元(如 < 和 &)以及不可見的字元(如空格)。
<!-- Not recommended -->
The currency symbol for the Euro is “&eur;”.
<!-- Recommended -->
The currency symbol for the Euro is “€”.
type 屬性
在引用樣式表和指令碼時,不要指定 type 屬性,除非不是 CSS 或 JavaScript。因為 HTML5 中已經預設指定樣式變的 type 是 text/css,指令碼的type 是 text/javascript。
<!-- Not recommended -->
<link rel="stylesheet" href="//"
type="text/css">
<!-- Recommended -->
<link rel="stylesheet" href="//">
<!-- Not recommended -->
<script src="//"
type="text/javascript"></script>
<!-- Recommended -->
<script src="//"></script>
HTML格式規範
HTML 引號
屬性值用雙引號。
<!-- Not recommended -->
<a class='maia-button maia-button-secondary'>Sign in</a>
<!-- Recommended -->
<a class="maia-button maia-button-secondary">Sign in</a>
CSS風格規範
ID 和 Class 命名
使用有含義的 id 和 class 名稱。
/* Not recommended: meaningless */#yee-1901 {}/* Not recommended: presentational */
on-green {}
r {}
/* Recommended: specific */#gallery {}#login {}o {}
/* Recommended: generic */
{}
{}
ID 和 Class 命名風格
id 和 class 應該儘量簡短,同時要容易理解。
/* Not recommended */#navigation {} {}
/* Recommended */#nav {}or {}
選擇器
除非需要,否則不要在 id 或 class 前加元素名。
/* Not recommended */
ul#example {}r {}
/* Recommended */#example {}r {}
屬性簡寫
儘量使用 CSS 中可以簡寫的屬性 (如 font),可以提高編碼效率以及程式碼可讀性。
/* Not recommended */
border-top-style: none;
font-family: palatino, georgia, serif;
font-size: 100%;
line-height: 1.6;
padding-bottom: 2em;
padding-left: 1em;
padding-right: 1em;
padding-top: 0;
/* Recommended */
border-top: 0;
font: 100%/1.6 palatino, georgia, serif;
padding: 0 1em 2em;
0 和單位
值為 0 時不用新增單位。
margin: 0;
padding: 0;
開頭的` 0
值在 -1 和 1 之間時,不需要加 0。
font-size: .8em;
16進製表示法
/* Not recommended */
color: #eebbcc;
/* Recommended */
color: #ebc;
字首
使用帶字首的名稱空間可以防止命名衝突,同時提高程式碼可維護性。
-help {} /* AdWords */#maia-note {} /* Maia */
ID 和 Class 命名分隔符
選擇器中使用連字元可以提高可讀性。
/* Not recommended: does not separate the words “demo” and “image” */
image {}
/* Not recommended: uses underscore instead of hyphen */
r_status {}
/* Recommended */#video-id {}-sample {}
CSS格式規範
書寫順序
按照屬性首字母順序書寫 CSS 易於閱讀和維護,排序時忽略帶有瀏覽器字首的屬性。
background: fuchsia;
border: 1px solid;
-moz-border-radius: 4px;
-webkit-border-radius: 4px;
border-radius: 4px;
color: black;
text-align: center;
text-indent: 2em;
塊級內容縮排
為了反映層級關係和提高可讀性,塊級內容都應縮排。
@media screen, projection {
html {
background: #fff;
color: #444;
}
}
宣告結束
每行 CSS 都應以分號結尾。
/* Not recommended */
{
display: block;
height: 100px
}
/* Recommended */
{
display: block;
height: 100px;
}
屬性名結尾
屬性名和值之間都應有一個空格。
/* Not recommended */
h3 {
font-weight:bold;
}
/* Recommended */
h3 {
font-weight: bold;
}
宣告樣式塊的分隔
在選擇器和 {} 之間用空格隔開。
/* Not recommended: missing space */#video{
margin-top: 1em;
}
/* Not recommended: unnecessary line break */#video{
margin-top: 1em;
}
/* Recommended */#video {
margin-top: 1em;
}
選擇器分隔
每個選擇器都另起一行。
/* Not recommended */
a:focus, a:active {
position: relative; top: 1px;
}
/* Recommended */
h1,
h2,
h3 {
font-weight: normal;
line-height: 1.2;
}
規則分隔
規則之間都用空行隔開。
html {
background: #fff;}
body {
margin: auto;
width: 50%;
}
CSS 引號
屬性選擇器和屬性值用單引號,URI 的值不需要引號。
/* Not recommended */@import url("//");html {
font-family: "open sans", arial, sans-serif;
}
/* Recommended */@import url(//);html {
font-family: 'open sans', arial, sans-serif;
}
CSS元規則
分段註釋
用註釋把 CSS 分成各個部分。
/* Header */#adw-header {}/* Footer */#adw-footer {}/* Gallery */
-gallery {}
結語
堅持遵循程式碼規範。
寫程式碼前先看看周圍同事的程式碼,然後決定程式碼風格。
程式碼規範的意義在於提供一個參照物。這裡提供了一份全域性的規範,但是你也得參照公司內部的規範,否則閱讀你程式碼的人會很痛苦。