很多 Web 开发人员对 HTML 的代码规范知之甚少。
在2000年至2010年,许多Web开发人员从 HTML 转换到 XHTML。
使用 XHTML 开发人员逐渐养成了比较好的 HTML 编写规范。
而针对于 HTML5 ,我们应该形成比较好的代码规范,以下提供了几种规范的建议。
文档类型声明位于HTML文档的第一行:
<!DOCTYPE html>
如果你想跟其他标签一样使用小写,可以使用以下代码:
<!doctype html>
HTML5 元素名可以使用大写和小写字母。
推荐使用小写字母:
<SECTION> <p>这是一个段落。</p> </SECTION>
<Section> <p>这是一个段落。</p> </SECTION>
<section> <p>这是一个段落。</p> </section>
在 HTML5 中, 你不一定要关闭所有元素 (例如 <p> 元素),但我们建议每个元素都要添加关闭标签。
<section> <p>这是一个段落。 <p>这是一个段落。 </section>
<section> <p>这是一个段落。</p> <p>这是一个段落。</p> </section>
在 HTML5 中, 空的 HTML 元素也不一定要关闭:
我们可以这么写:
<meta charset="utf-8">
也可以这么写:
<meta charset="utf-8" />
在 XHTML 和 XML 中斜线 (/) 是必须的。
如果你期望 XML 软件使用你的页面,使用这种风格是非常好的。
HTML5 属性名允许使用大写和小写字母。
我们推荐使用小写字母属性名:
<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>菜鸟学堂</h1> <h2>HTML</h2> <p> 菜鸟学堂,学的不仅是技术,更是梦想。 菜鸟学堂,学的不仅是技术,更是梦想。 菜鸟学堂,学的不仅是技术,更是梦想, 菜鸟学堂,学的不仅是技术,更是梦想。 </p> </body>
<body> <h1>菜鸟学堂</h1> <h2></h2> <p>菜鸟学堂,学的不仅是技术,更是梦想。 菜鸟学堂,学的不仅是技术,更是梦想。 菜鸟学堂,学的不仅是技术,更是梦想。 菜鸟学堂,学的不仅是技术,更是梦想。</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 中, <html> 和 <body> 标签是可以省略的。
以下 HTML5 文档是正确的:
不推荐省略 <html> 和 <body> 标签。
<html> 元素是文档的根元素,用于描述页面的语言:
<!DOCTYPE html> <html lang="zh">
声明语言是为了方便屏幕阅读器及搜索引擎。
省略 <html> 或 <body> 在 DOM 和 XML 软件中会崩溃。
省略 <body> 在旧版浏览器 (IE9)会发生错误。
在标准 HTML5 中, <head>标签是可以省略的。
默认情况下,浏览器会将 <body> 之前的内容添加到一个默认的 <head> 元素上。
<!DOCTYPE html> <html> <title>页面标题</title> <body> <h1>这是一个标题</h1> <p>这是一个段落。</p> </body> </html>尝试一下 »
现在省略 head 标签还不推荐使用。 |
HTML5 中 <title> 元素是必须的,标题名描述了页面的主题:
<title>菜鸟学堂</title>
标题和语言可以让搜索引擎很快了解你页面的主题:
<!DOCTYPE html> <html lang="zh"> <head> <meta charset="UTF-8"> <title>菜鸟学堂</title> </head>
注释可以写在 <!-- 和 --> 中:
<!-- 这是注释 -->
比较长的评论可以在 <!-- 和 --> 中分行写:
<!-- 这是一个较长评论。 这是 一个较长评论。这是一个较长评论。 这是 一个较长评论 这是一个较长评论。 这是 一个较长评论。 -->
长评论第一个字符缩进两个空格,更易于阅读。
样式表使用简洁的语法格式 ( 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; }
在逗号和冒号后添加空格是常用的一个规则。 |
使用简洁的语法来载入外部的脚本文件 ( type 属性不是必须的 ):
<script src="myscript.js">
一个糟糕的 HTML 格式可能会导致 JavaScript 执行错误。
以下两个 JavaScript 语句会输出不同结果:
HTML 中 JavaScript 尽量使用相同的命名规则。
大多 Web 服务器 (Apache, Unix) 对大小写敏感: london.jpg 不能通过 London.jpg 访问。
其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感: london.jpg 可以通过 London.jpg 或 london.jpg 访问。
你必须保持统一的风格,我们建议统一使用小写的文件名。
HTML 文件后缀可以是 .html (或 .htm)。
CSS 文件后缀是 .css 。
JavaScript 文件后缀是 .js 。
.htm 和 .html 的扩展名文件本质上是没有区别的。浏览器和 Web 服务器都会把它们当作 HTML 文件来处理。
区别在于:
.htm 应用在早期 DOS 系统,系统现在或者只能有三个字符。
在 Unix 系统中后缀没有特别限制,一般用 .html。
如果一个 URL 没有指定文件名 (如 http://edu.jb51.net/css/), 服务器会返回默认的文件名。通常默认文件名为 index.html, index.htm, default.html, 和 default.htm。
如果服务器只配置了 "index.html" 作为默认文件,你必须将文件命名为 "index.html", 而不是 "index.htm"。
但是,通常服务器可以设置多个默认文件,你可以根据需要设置默认文件名。
不管怎样,HTML 完整的后缀是 ".html"。