HTML(5) 代码规范



HTML 代码约定

很多 Web 开发人员对 HTML 的代码规范知之甚少。

在2000年至2010年,许多Web开发人员从 HTML 转换到 XHTML。

使用 XHTML 开发人员逐渐养成了比较好的 HTML 编写规范。

而针对于 HTML5 ,我们应该形成比较好的代码规范,以下提供了几种规范的建议。


使用正确的文档类型

文档类型声明位于HTML文档的第一行:

<!DOCTYPE html>

如果你想跟其他标签一样使用小写,可以使用以下代码:

<!doctype html>

使用小写元素名

HTML5 元素名可以使用大写和小写字母。

推荐使用小写字母:

  • 混合了大小写的风格是非常糟糕的。

  • 开发人员通常使用小写 (类似 XHTML)。

  • 小写风格看起来更加清爽。

  • 小写字母容易编写。

不推荐:

<SECTION>
  <p>这是一个段落。</p>
</SECTION>

非常糟糕:

<Section>
  <p>这是一个段落。</p>
</SECTION>

推荐:

<section>
  <p>这是一个段落。</p>
</section>

关闭所有 HTML 元素

在 HTML5 中, 你不一定要关闭所有元素 (例如

元素),但我们建议每个元素都要添加关闭标签。

不推荐:

<section>
  <p>这是一个段落。
  <p>这是一个段落。
   </section>

推荐:

<section>
  <p>这是一个段落。</p>
  <p>这是一个段落。</p>
   </section>

关闭空的 HTML 元素

在 HTML5 中, 空的 HTML 元素也不一定要关闭:

我们可以这么写:

<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">

但我们推荐少用空格:

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

避免一行代码过长

使用 HTML 编辑器,左右滚动代码是不方便的。

每行代码尽量少于 80 个字符。


空行和缩进

不要无缘无故添加空行。

为每个逻辑功能块添加空行,这样更易于阅读。

缩进使用两个空格,不建议使用 TAB。

比较短的代码间不要使用不必要的空行很缩进。

不必要的空行和缩进:

<body>

  <h1>php中文网</h1>

  <h2>HTML</h2>
   
  <p>
    php中文网,学的不仅是技术,更是梦想。
    php中文网,学的不仅是技术,更是梦想。
   php中文网,学的不仅是技术,更是梦想,
       php中文网,学的不仅是技术,更是梦想。
  </p>

</body>

推荐:

<body>

<h1>php中文网</h1>

<h2></h2>
   <p>php中文网,学的不仅是技术,更是梦想。
php中文网,学的不仅是技术,更是梦想。
php中文网,学的不仅是技术,更是梦想。
php中文网,学的不仅是技术,更是梦想。</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>London</li>
  <li>Paris</li>
        <li>Tokyo</li>
</ol>

省略 和 ?

在标准 HTML5 中, 和 标签是可以省略的。

以下 HTML5 文档是正确的:

实例




php中文网(php.cn)


这是一个标题

这是一个段落。


运行实例 »

点击 "运行实例" 按钮查看在线实例

不推荐省略 和 标签。

元素是文档的根元素,用于描述页面的语言:

<!DOCTYPE html>
<html lang="zh">

声明语言是为了方便屏幕阅读器及搜索引擎。

省略 或 在 DOM 和 XML 软件中会崩溃。

省略 在旧版浏览器 (IE9)会发生错误。


省略 ?

在标准 HTML5 中, 标签是可以省略的。

默认情况下,浏览器会将 之前的内容添加到一个默认的 元素上。

实例




php中文网(php.cn)


段落 1。

段落 2。


运行实例 »

点击 "运行实例" 按钮查看在线实例

Note现在省略 head 标签还不推荐使用。

元数据

HTML5 中 元素是必须的,标题名描述了页面的主题:</p><div class="example"><div class="example_code"><span class="highLT"><</span><span class="highELE">title</span><span class="highGT">></span>php中文网<span class="highLT"><</span><span class="highELE">/title</span><span class="highGT">></span></div></div><p>标题和语言可以让搜索引擎很快了解你页面的主题:</p><div class="example"><div class="example_code"><span class="highLT"><</span><span class="highELE">!DOCTYPE</span> <span class="highATT">html</span><span class="highGT">></span><br/><span class="highLT"><</span><span class="highELE">html</span>    <span class="highATT">lang=</span><span class="highVAL">"zh"</span><span class="highGT">></span><br/><span class="highLT"><</span><span class="highELE">head</span><span class="highGT">></span><br/>  <span class="highLT"><</span><span class="highELE">meta</span> <span class="highATT">charset=</span><span class="highVAL">"UTF-8"</span><span class="highGT">></span><br/>  <span class="highLT"><</span><span class="highELE">title</span><span class="highGT">></span>php中文网<span class="highLT"><</span><span class="highELE">/title</span><span class="highGT">></span><br/><span class="highLT"><</span><span class="highELE">/head</span><span class="highGT">></span></div></div><hr/><h2>HTML 注释</h2><p>注释可以写在 <!-- 和 --> 中:</p><div class="example"><div class="example_code"><span class="highCOM"><!-- 这是注释 --></span></div></div><p>比较长的评论可以在 <!-- 和 --> 中分行写:</p><div class="example"><div class="example_code"><span class="highCOM"><!-- <br/>  这是一个较长评论。 这是  一个较长评论。这是一个较长评论。<br/>  这是  一个较长评论 这是一个较长评论。 这是  一个较长评论。<br/>--></span></div></div><p>长评论第一个字符缩进两个空格,更易于阅读。</p><hr/><h2>样式表</h2><p>样式表使用简洁的语法格式 ( type 属性不是必须的):</p><div class="example"><div class="example_code"><span class="highLT"><</span><span class="highELE">link</span> <span class="highATT">rel=</span><span class="highVAL">"stylesheet"</span> <span class="highATT">href=</span><span class="highVAL">"styles.css"</span><span class="highGT">></span></div></div><p>短的规则可以写成一行:</p><div class="example"><div class="example_code"><span class="highELE">p.into </span>{<span class="highATT">font-family:</span><span class="highVAL"> Verdana;</span> <span class="highATT">font-size:</span><span class="highVAL"> 16em;</span>}</div></div><p>长的规则可以写成多行:</p><div class="example"><div class="example_code"><span class="highELE">body </span>{<br/>  <span class="highATT">background-color:</span><span class="highVAL"> lightgrey;</span><br/>  <span class="highATT">font-family:</span><span class="highVAL"> "Arial Black", Helvetica, sans-serif;</span><br/>  <span class="highATT">font-size:</span><span class="highVAL"> 16em;</span><br/>  <span class="highATT">color:</span><span class="highVAL"> black;</span><br/>}</div></div><ul class=" list-paddingleft-2"><li><p>将左花括号与选择器放在同一行。</p></li><li><p>左花括号与选择器间添加以空格。</p></li><li><p>使用两个空格来缩进。</p></li><li><p>冒号与属性值之间添加已空格。</p></li><li><p>逗号和符号之后使用一个空格。</p></li><li><p>每个属性与值结尾都要使用符号。</p></li><li><p>只有属性值包含空格时才使用引号。</p></li><li><p>右花括号放在新的一行。</p></li><li><p>每行最多 80 个字符。</p></li></ul><table class="lamp"><tbody><tr class="firstRow"><th style="width:34px"><img src="/upload/course/000/000/010/58043146a1da1979.jpg" alt="Note"/></th><td>在逗号和分号后添加空格是常用的一个规则。</td></tr></tbody></table><hr/><h2>在 HTML 中载入 JavaScript</h2><p>使用简洁的语法来载入外部的脚本文件 ( type 属性不是必须的 ):</p><div class="example"><div class="example_code"><span class="highLT"><</span><span class="highELE">script</span> <span class="highATT">src=</span><span class="highVAL">"myscript.js"</span><span class="highGT">></span></div></div><hr/><h2>使用 JavaScript 访问 HTML 元素</h2><p>一个糟糕的 HTML 格式可能会导致 JavaScript 执行错误。</p><p>以下两个 JavaScript 语句会输出不同结果:</p><div class="example"><h2 class="example">实例</h2><div class="example_code"><pre class="brush:html;toolbar:false"><!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>php中文网(php.cn) 段落 1。

段落 2。


运行实例 »

点击 "运行实例" 按钮查看在线实例