首页 > 网站 > WEB开发 > 正文

前端编码风格规范之 HTML 规范

2024-04-27 14:13:51
字体:
来源:转载
供稿:网友

前端编码风格规范之 HTML 规范

HTML 规范


文档类型

推荐使用 HTML5 的文档类型申明:<!DOCTYPE html>.

(建议使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的属性,比如application/xhtml+xml在浏览器中的应用支持与优化空间都十分有限)。

HTML 中最好不要将无内容元素[1]的标签闭合,例如:使用<br>而非<br />.


HTML 验证

一般情况下,建议使用能通过标准规范验证的 HTML 代码,除非在性能优化和控制文件大小上不得不做出让步。

使用诸如 W3C HTML validator 这样的工具来进行检测。

规范化的 HTML 是显现技术要求与局限的显著质量基线,它促进了 HTML 被更好地运用。

不推荐

<title>Test</title><article>This is only a test.

推荐

<!DOCTYPE html><meta charset="utf-8"><title>Test</title><article>This is only a test.</article>

省略可选标签

HTML5 规范中规定了 HTML 标签是可以省略的。但从可读性来说,在开发的源文件中最好不要这样做,因为省略标签可能会导致一些问题。

省略一些可选的标签确实使得页面大小减少,这很有用,尤其是对于一些大型网站来说。为了达到这一目的,我们可以在开发后期对页面进行压缩处理,在这个环节中这些可选的标签完全就可以省略掉了。


脚本加载

出于性能考虑,脚本异步加载很关键。一段脚本放置在<head>内,比如<script src="main.js"></script>,其加载会一直阻塞 DOM 解析,直至它完全地加载和执行完毕。这会造成页面显示的延迟。特别是一些重量级的脚本,对用户体验来说那真是一个巨大的影响。

异步加载脚本可缓解这种性能影响。如果只需兼容 IE10+,可将 HTML5 的 async 属性加至脚本中,它可防止阻塞 DOM 的解析,甚至你可以将脚本引用写在<head>里也没有影响。

如需兼容老旧的浏览器,实践表明可使用用来动态注入脚本的脚本加载器。你可以考虑yepnope或labjs。注入脚本的一个问题是:一直要等到 CSS 对象文档已就绪,它们才开始加载(短暂地在 CSS 加载完毕之后),这就对需要及时触发的 JS 造成了一定的延迟,这多多少少也影响了用户体验吧。

终上所述,兼容老旧浏览器(IE9-)时,应该遵循以下最佳实践。

脚本引用写在 body 结束标签之前,并带上 async 属性。这虽然在老旧浏览器中不会异步加载脚本,但它只阻塞了 body 结束标签之前的 DOM 解析,这就大大降低了其阻塞影响。而在现代浏览器中,脚本将在 DOM 解析器发现 body 尾部的 script 标签才进行加载,此时加载属于异步加载,不会阻塞 CSSOM(但其执行仍发生在 CSSOM 之后)。

所有浏览器中,推荐

<html>  <head>    <link rel="stylesheet" href="main.css">  </head>  <body>    <!-- body goes here -->    <script src="main.js" async></script>  </body></html>

只在现代浏览器中,推荐

<html>  <head>    <link rel="stylesheet" href="main.css">    <script src="main.js" async></script>  </head>  <body>    <!-- body goes here -->  </body></html>

语义化

根据元素(有时被错误地称作“标签”)其被创造出来时的初始意义来使用它。打个比方,用 heading 元素来定义头部标题,p 元素来定义文字段落,用 a 元素来定义链接锚点,等等。

有根据有目的地使用 HTML 元素,对于可访问性、代码重用、代码效率来说意义重大。

以下示例列出了一些的语义化 HTML 主要情况:

不推荐

<b>My page title</b><div class="top-navigation">  <div class="nav-item"><a href="#home">Home</a></div>  <div class="nav-item"><a href="#news">News</a></div>  <div class="nav-item"><a href="#about">About</a></div></div><div class="news-page">  <div class="page-section news">    <div class="title">All news articles</div>    <div class="news-article">      <h2>Bad article</h2>      <div class="intro">Introduction sub-title</div>      <div class="content">This is a very bad example for HTML semantics</div>      <div class="article-side-notes">I think I'm more on the side and should not receive the main credits</div>      <div class="article-foot-notes">        This article was created by David <div class="time">2014-01-01 00:00</div>      </div>    </div>    <div class="section-footer">      Related sections: Events, Public holidays    </div>  </div></div><div class="page-footer">  Copyright 2014</div>

推荐

<!-- The page header should go into a header element --><header>  <!-- As this title belongs to the page structure it's a heading and h1 should be used -->  <h1>My page title</h1></header><!-- All navigation should go into a nav element --><nav class="top-navigation">  <!-- A listing of elements should always go to UL (OL for ordered listings) -->  <ul>    <li class="nav-item"><a href="#home">Home</a></li>    <li class="nav-item"><a href="#news">News</a></li>    <li class="nav-item"><a href="#about">About</a></li>  </ul></nav><!-- The main part of the page should go into a main element (also use role="main" for accessibility) --><main class="news-page" role="main">  <!-- A section of a page should go into a section element. Divide a page into sections with semantic elements. -->  <section class="page-section news">    <!-- A section header should go into a section element -->    <header>      <!-- As a page section belongs to the page structure heading elements should be used (in this case h2) -->      <h2 class="title">All news articles</h2>    </header>    <!-- If a section / module can be seen as an article (news article, blog entry, PRoducts teaser, any other     re-usable module / section that can occur multiple times on a page) a article element should be used -->    <article class="news-article">      <!-- An article can contain a header that contains the summary / introduction information of the article -->      <header>        <!-- As a article title does not belong to the overall page structure there should not be any heading tag! -->        <div class="article-title">Good article</div>        <!-- Small can optionally be used to reduce importance -->        <small class="intro">Introduction sub-title</small>      </header>      <!-- For the main content in a section or article there is no semantic element -->      <div class="content">        <p>This is a good example for HTML semantics</p>      </div>      <!-- For content that is represented as side note or less important information in a given context use aside -->      <aside class="article-side-notes">        <p>I think I'm more on the side and should not receive the main credits</p>      </aside>      <!-- Articles can also contain footers. If you have footnotes for an article place them into a footer element -->      <footer class="article-foot-notes">        <!-- The time element can be used to annotate a timestamp. Use the datetime attribute to specify ISO time         while the actual text in the time element can also be more human readable / relative -->        <p>This article was created by David <time datetime="2014-01-01 00:00" class="time">1 month ago</time></p>      </footer>    </article>    <!-- In a section, footnotes or similar information can also go into a footer element -->    <footer class="section-footer">      <p>Related sections: Events, Public holidays</p>    </footer>  </section></main><!-- Your page footer should go into a global footer element --><footer class="page-footer">  Copyright 2014</footer>

多媒体回溯

对页面上的媒体而言,像图片、视频、canvas 动画等,要确保其有可替代的接入接口。图片文件我们可采用有意义的备选文本(alt),视频和音频文件我们可以为其加上说明文字或字幕。

提供可替代内容对可用性来说十分重要。试想,一位盲人用户如何能知晓一张图片是什么,要是没有 @alt 的话。

(图片的 alt 属性是可不填写内容的,纯装饰性的图片就可用这么做:alt="")。

不推荐

<img src="luke-skywalker.jpg">

推荐

<img src="luke-skywalker.jpg" alt="Luke skywalker riding an alien horse">

尽量用 alt 标签去描述图片,设想你需要对于那些只能通过语音或者看不见图片的用户表达图片到底是什么。

不推荐

<img src="huge-spaceship-approaching-earth.jpg" alt="Header image">

推荐

<img src="huge
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表