HTML(5) 樣式指南和代碼約定

HTML 代碼約定

web 開發者常常不確定在HTML 中使用的代碼樣式和語法。

在2000 年至2010 年之間,許多web 開發者從HTML 轉換為XHTML。

通過XHTML,開發者不得不編寫有效的“格式良好的”代碼。

HTML5 在代碼驗證時會更寬鬆一點。

通過HTML5,您必須創建屬於自己的最佳實踐、樣式指南和代碼約定

智能且有未來保證

對樣式的合乎邏輯的使用,可以令其他人更容易理解和使用您的HTML。

在未來,諸如XML 閱讀器之類的程序,也許需要閱讀您的HTML。

使用格式良好的“近似XHTML 的”語法,能夠更智能。

註釋:請始終保持您的樣式智能、整潔、純淨、格式良好。

請使用正確的文檔類型

請始終在文檔的首行聲明文檔類型:

<!DOCTYPE html>

如果您一貫堅持小寫標籤,那麼可以使用:

<!doctype html>

請使用小寫元素名

HTML5 允許在元素名中使用混合大小寫字母。

我們推薦使用小寫元素名:

  • 混合大小寫名稱並不好
  • 開發者習慣使用小寫名(比如在XHTML 中)
  • 小寫更起來更純淨
  • 小寫更易書寫

不太好:

<SECTION> 
  <p>This is a paragraph.</p>
</SECTION>

很糟糕:

<Section> 
  <p>This is a paragraph.</p>
</SECTION>

還不錯:

<section> 
  <p>This is a paragraph.</p>
</section>

關閉所有HTML 元素

在HTML5 中,您不必關閉所有元素(例如<p> 元素)。

我們建議關閉所有HTML 元素:

看起來不好:

<section>
  <p>This is a paragraph.
  <p>This is a paragraph.
</section>

看起來不錯:

<section>
  <p>This is a paragraph.</p>
  <p>This is a paragraph.</p>
</section>

關閉空的HTML 元素

在HTML5 中,關閉空元素是可選的。

允許這樣:

<meta charset="utf-8">

也允許這樣:

<meta charset="utf-8" />

斜杠(/)在XHTML 和XML 中是必需的。

如果您期望XML 軟件來訪問您的頁面,保持這個習慣是個好主意。

使用小寫屬性名

HTML5 允許大小寫混合的屬性名。

我們建議使用小寫屬性名:

  • 混合屬性名並不好
  • 開發者習慣於使用小寫屬性名(比如在XHTML 中)
  • 小寫屬性名看情況更純淨
  • 小寫屬性名更易書寫

看起來不好:

<div CLASS="menu">

看起來不錯:

<div class="menu">

屬性值加引號

HTML5 允許不加引號的屬性值。

我們推薦屬性值加引號:

  • 如果屬性值包含值,則必須使用引號
  • 混合樣式絕對不好
  • 加引號的值更易閱讀

這個屬性值無效,因為值中包含空格:

<table class=table striped>

這樣是有效的:

<table class="table striped">

必需的屬性

請始終對圖像使用alt屬性。當圖像無法顯示時該屬性很重要。

<img src="html5.gif" alt="HTML5" style="width:128px;height:128px">

請始終定義圖像尺寸。這樣做會減少閃爍,因為瀏覽器會在圖像加載之前為圖像預留空間。

<img src="html5.gif" alt="HTML5" style="width:128px;height:128px">

空格和等號

等號兩邊的空格是合法的:

<link rel = "stylesheet" href = "styles.css">

但是精簡空格更易閱讀, But space-less is easier to read, and groups entities better together:

<link rel="stylesheet" href="styles.css">

避免長代碼行

當使用HTML 編輯器時,通過左右滾動來閱讀HTML 代碼很不方便。

請盡量避免代碼行超過80 個字符。

空行和縮進

請勿毫無理由地增加空行。

為了提高可讀性,請增加空行來分隔大型或邏輯代碼塊。

為了提高可讀性,請增加兩個空格的縮進。請勿使用TAB。

請勿使用沒有必要的空行和縮進。沒有必要在短的和相關項目之間使用空行,也沒有必要縮進每個元素:

不必要:

<body>

  <h1>Famous Cities</1>

  <h2>Tokyo</h2>

  <p>
    Tokyo is the capital of Japan, the center of the Greater Tokyo Area,
    and the most populous metropolitan area in the world.
    It is the seat of the Japanese government and the Imperial Palace,
    and the home of the Japanese Imperial Family.
  </p>

</body>

更好:

<body>

<h1>Famous Cities</1>
<h2>Tokyo</h2>

<p>
Tokyo is the capital of Japan, the center of the Greater Tokyo Area,
and the most populous metropolitan area in the world.
It is the seat of the Japanese government and the Imperial Palace,
and the home of the Japanese Imperial Family.
</p>

</body>

表格示例:

<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
  <tr>
  <tr>
    <td>A</td>
    <td>Description of A</td>
  <tr>
  <tr>
    <td>B</td>
    <td>Description of B</td>
  <tr>
</table>

列表示例:

<ol>
  <li>LondonA</li>
  <li>Paris</li>
  <li>Tokyo</li>
</ol>

省略<html> 和<body>?

在HTML5 標準中,能夠省略<html> 標籤和<body> 標籤。

以下代碼作為HTML5 進行驗證:

示例

<!DOCTYPE html>
<head>
  <title>Page Title</title>
</head>

<h1>This is a heading</h1>
<p>This is a paragraph.</p>

親自試一試

我們不推薦省略<html> 和<body> 標籤。

<html> 元素是文本的根元素。它是規定頁面語言的理想位置。

<!DOCTYPE html>
<html lang="en-US">

對於可訪問應用程序(屏幕閱讀器)和搜索引擎,聲明語言很重要。

省略<html> 或<body> c可令DOM 和XML 軟件崩潰。

省略<body> 會在老式瀏覽器(IE9)中產生錯誤。

省略<head>?

在HTML5 標準中,<head> 標籤也能夠被省略。

默認地,瀏覽器會把<body> 之前的所有元素添加到默認的<head> 元素。

通過省略<head> 標籤,您能夠降低HTML 的複雜性:

示例

<!DOCTYPE html>
<html>
<title>Page Title</title>

<body>
  <h1>This is a heading</h1>
  <p>This is a paragraph.</p>
</body>

</html>

親自試一試

註釋:對於web開發者,省略標籤的做法是陌生的。建立規則需要時間。

元數據

<title> 元素在HTML5 中是必需的。請盡可能製作有意義的標題。

<title>HTML5 Syntax and Coding Style</title>

為了確保恰當的解釋,以及正確的搜索引擎索引,在文檔中對語言和字符編碼的定義越早越好:

<!DOCTYPE html>
<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <title>HTML5 Syntax and Coding Style</title>
</head>

HTML 註釋

短註釋應該在單行中書寫,並在<!– 之後增加一個空格,在<!– 之前增加一個空格:

<!-- This is a comment -->

長註釋,跨越多行,應該通過<!– 和–> 在獨立的行中書寫:

<!-- 
  This is a long comment example. This is a long comment example. This is a long comment example.
  This is a long comment example. This is a long comment example. This is a long comment example.
-->

長註釋更易觀察,如果它們被縮進兩個空格的話。

樣式表

請使用簡單的語法來鏈接樣式表(type 屬性不是必需的):

<link rel="stylesheet" href="styles.css">

短規則可以壓縮為一行,就像這樣:

p.into {font-family:"Verdana"; font-size:16em;}

長規則應該分為多行:

body {
  background-color: lightgrey;
  font-family: "Arial Black", Helvetica, sans-serif;
  font-size: 16em;
  color: black;
}
  • 開括號與選擇器位於同一行
  • 在開括號之前用一個空格
  • 使用兩個字符的縮進
  • 在每個屬性與其值之間使用冒號加一個空格
  • 在每個逗號或分號之後使用空格
  • 在每個屬性值對(包括最後一個)之後使用分號
  • 只在值包含空格時使用引號來包圍值
  • 把閉括號放在新的一行,之前不用空格
  • 避免每行超過80 個字符

註釋:在逗號或分號之後添加空格,是所有書寫類型的通用規則。

在HTML 中加載JavaScript

請使用簡單的語法來加載外部腳本(type 屬性不是必需的):

<script src="myscript.js">

通過JavaScript 訪問HTML 元素

使用“不整潔”的HTML 樣式的後果,是可能會導致JavaScript 錯誤。

這兩個JavaScript 語句會產生不同的結果:

var obj = getElementById("Demo")

var obj = getElementById("demo")

親自試一試

如果可能,請在HTML 中使用(與JavaScript)相同的命名約定。

請訪問JavaScript 樣式指南。

使用小寫文件名

大多數web 服務器(Apache、Unix)對文件名的大小寫敏感:

不能以london.jpg 訪問London.jpg。

其他web 服務器(微軟,IIS)對大小寫不敏感:

能夠以london.jpg 或London.jpg 訪問London.jpg。

如果使用混合大小寫,那麼您必須保持高度的一致性。

如果您從對大小寫不敏感的服務器轉到一台對大小寫敏感的服務器上,這些小錯誤將破壞您的網站。

為了避免這些問題,請始終使用小寫文件名(如果可以的話)。

文件擴展名

HTML文件名應該使用擴展名.html(而不是.htm)。

CSS文件應該使用擴展名.css

JavaScript文件應該使用擴展名.js

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *