[譯]谷歌 HTML/CSS 規範

時間 2019-11-05

標籤谷歌 html css 規範欄目 Chrome 简体版

原文原文鏈接

原文 Google HTML/CSS Style Guidejavascript

背景

這篇文章定義了 HTML 和 CSS 的格式和代碼規範，旨在提升代碼質量和協做效率。css

通用樣式規範

協議

圖片，樣式表，腳本及其餘媒體文件儘可能使用 HTTPS 協議，除非該文件不支持 HTTPS。html

<!-- Not recommended: omits the protocol -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>

<!-- Not recommended: uses the HTTP protocol -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>

<!-- Recommended -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>

/* Not recommended: omits the protocol */
@import '//fonts.googleapis.com/css?family=Open+Sans';

/* Not recommended: uses the HTTP protocol */
@import 'http://fonts.googleapis.com/css?family=Open+Sans';

/* Recommended */
@import 'https://fonts.googleapis.com/css?family=Open+Sans';

通用格式規範

縮進

一次縮進2個空格，不要使用 tab 或者混合 tab 和空格的縮進。java

<ul>
  <li>Fantastic
  <li>Great
</ul>

.example {
  color: blue;
}

大小寫

如下都應該用小寫：
HTML 元素名稱，屬性，屬性值（除非 text/CDATA），CSS 選擇器，屬性，屬性值。jquery

<!-- Not recommended -->
<A HREF="/">Home</A>

<!-- Recommended -->
<img src="google.png" alt="Google">

/* Not recommended */
color: #E5E5E5;

/* Recommended */
color: #e5e5e5;

結尾空格

結尾空格不只多餘，並且在比較代碼時會更麻煩。git

<!-- Not recommended -->
<p>What?_

<!-- Recommended -->
<p>Yes please.

通用元規範

編碼

在 HTML 中經過 <meta charset="utf-8"> 指定編碼方式，CSS 中不須要指定，由於默認是 UTF-8。github

註釋

使用註釋來解釋代碼：包含的模塊，功能以及優勢。web

任務項

用 TODO 來標記待辦事項，而不是用一些其餘的標記，像 @@。ajax

<!-- TODO: remove optional tags -->
<ul>
  <li>Apples</li>
  <li>Oranges</li>
</ul>

HTML 風格規範

文檔類型

HTML 文檔應使用 HTML5 的文檔類型：<!DOCTYPE html>。
孤立標籤無需封閉自身，<br> 不要寫成 <br />。canvas

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 -->
<div onclick="goToRecommendations();">All recommendations</div>

<!-- 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 &ldquo;&eur;&rdquo;.

<!-- 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="//www.google.com/css/maia.css"
  type="text/css">

<!-- Recommended -->
<link rel="stylesheet" href="//www.google.com/css/maia.css">

<!-- Not recommended -->
<script src="//www.google.com/js/gweb/analytics/autotrack.js"
  type="text/javascript"></script>

<!-- Recommended -->
<script src="//www.google.com/js/gweb/analytics/autotrack.js"></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 */
.button-green {}
.clear {}

/* Recommended: specific */
#gallery {}
#login {}
.video {}

/* Recommended: generic */
.aux {}
.alt {}

ID 和 Class 命名風格

id 和 class 應該儘可能簡短，同時要容易理解。

/* Not recommended */
#navigation {}
.atr {}

/* Recommended */
#nav {}
.author {}

選擇器

除非須要，不然不要在 id 或 class 前加元素名。

/* Not recommended */
ul#example {}
div.error {}

/* Recommended */
#example {}
.error {}

屬性簡寫

儘可能使用 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;

前綴

使用帶前綴的命名空間能夠防止命名衝突，同時提升代碼可維護性。

.adw-help {} /* AdWords */
#maia-note {} /* Maia */

ID 和 Class 命名分隔符

選擇器中使用連字符能夠提升可讀性。

/* Not recommended: does not separate the words 「demo」 and 「image」 */
.demoimage {}

/* Not recommended: uses underscore instead of hyphen */
.error_status {}

/* Recommended */
#video-id {}
.ads-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 */
.test {
  display: block;
  height: 100px
}

/* Recommended */
.test {
  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("//www.google.com/css/maia.css");

html {
  font-family: "open sans", arial, sans-serif;
}

/* Recommended */
@import url(//www.google.com/css/maia.css);

html {
  font-family: 'open sans', arial, sans-serif;
}

CSS 元規則

分段註釋

用註釋把 CSS 分紅各個部分。

/* Header */

#adw-header {}

/* Footer */

#adw-footer {}

/* Gallery */

.adw-gallery {}

結語

堅持遵循代碼規範。寫代碼前先看看周圍同事的代碼，而後決定代碼風格。代碼規範的意義在於提供一個參照物。這裏提供了一份全局的規範，可是你也得參照公司內部的規範，不然閱讀你代碼的人會很痛苦。

1. 谷歌HTML/CSS規範
2. 谷歌與Airbnb的JS代碼規範
3. 谷歌 HTML/CSS 規範 2016-12-30
4. [收藏]谷歌htm/css規範
5. 谷歌翻譯
6. emacs 添加谷歌翻譯
7. 【python命名規範】谷歌風格命名
8. 谷歌開源內部代碼評審規範
9. 谷歌C++編碼規範讀書筆記
10. 描述標籤（meta description）的規範講解 - 谷歌SEO基礎
更多相關文章...
• RDF 規則 - RDF 教程
• Eclipse 編譯項目 - Eclipse 教程
• Kotlin學習（一）基本語法
• 算法總結-股票買賣

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。