HTML规范(nec)

网易

发表于2013-06-26 23:52:21

HTML规范 - 整体结构

HTML基础设施
  • 文件应以“<!DOCTYPE ......>”首行顶格开始,推荐使用“<!DOCTYPE html>”。
  • 必须申明文档的编码charset,且与文件本身编码保持一致,推荐使用UTF-8编码<meta charset="utf-8"/>。
  • 根据页面内容和需求填写适当的keywords和description。
  • 页面title是极为重要的不可缺少的一项。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>NEC:更好的CSS方案</title>
<meta name="keywords" content=""/>
<meta name="description" content=""/>
<meta name="viewport" content="width=device-width"/>
<link rel="stylesheet" href="css/style.css"/>
<link rel="shortcut icon" href="img/favicon.ico"/>
<link rel="apple-touch-icon" href="img/touchicon.png"/>
</head>
<body>
 
</body>
</html>
结构顺序和视觉顺序基本保持一致
  • 按照从上至下、从左到右的视觉顺序书写HTML结构。
  • 有时候为了便于搜索引擎抓取,我们也会将重要内容在HTML结构顺序上提前。
  • 用div代替table布局,可以使HTML更具灵活性,也方便利用CSS控制。
  • table不建议用于布局,但表现具有明显表格形式的数据,table还是首选。
结构、表现、行为三者分离,避免内联
  • 使用link将css文件引入,并置于head中。
  • 使用script将js文件引入,并置于body底部。
保持良好的简洁的树形结构
  • 每一个块级元素都另起一行,每一行都使用Tab缩进对齐(head和body的子元素不需要缩进)。删除冗余的行尾的空格。
  • 使用4个空格代替1个Tab(大多数编辑器中可设置)。
  • 对于内容较为简单的表格,建议将tr写成单行。
  • 你也可以在大的模块之间用空行隔开,使模块更清晰。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<body>
<!-- 侧栏内容区 -->
<div class="m-side">
    <div class="side">
        <div class="sidein">
            <!-- 热门标签 -->
            <div class="sideblk">
                <div class="m-hd3"><h3 class="tit">热门标签</h3> </div>
                ...
            </div>
 
            <!-- 最热TOP5 -->
            <div class="sideblk">
                <div class="m-hd3"><h3 class="tit">最热TOP5</h3> <a href="#" class="s-fc02 f-fr">更多»</a></div>
                ...
            </div>
        </div>
    </div>
</div>
<!-- /侧栏内容区 -->
</body>
另外,请做到以下几点
  • 结构上如果可以并列书写,就不要嵌套。

    如果可以写成<div></div><div></div>那么就不要写成<div><div></div></div>

  • 如果结构已经可以满足视觉和语义的要求,那么就不要有额外的冗余的结构。

    比如<div><h2></h2></div>已经能满足要求,那么就不要再写成<div><div><h2></h2></div></div>

  • 一个标签上引用的className不要过多,越少越好。

    比如不要出现这种情况:<div class="class1 class2 class3 class4"></div>

  • 对于一个语义化的内部标签,应尽量避免使用className。

    比如在这样一个列表中,li标签中的itm应去除:<ul class="m-help"><li class="itm"></li><li class="itm"></li></ul>

HTML规范 - 代码格式

说明文案的注释方法

采用类似标签闭合的写法,与HTML统一格式;注释文案两头空格,与CSS注释统一格式。

  • 开始注释:<!-- 注释文案 -->(文案两头空格)。
  • 结束注释:<!-- /注释文案 -->(文案前加“/”符号,类似标签的闭合)。
  • 允许只有开始注释!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!-- 头部 -->
<div class="g-hd">
    <!-- LOGO -->
    <h1 class="m-logo"><a href="#">LOGO</a></h1>
    <!-- /LOGO -->
    <!-- 导航 -->
    <ul class="m-nav">
        <li><a href="#">NAV1</a></li>
        <li><a href="#">NAV2</a></li>
        <!-- 更多导航项 -->
    </ul>
    <!-- /导航 -->
</div>
<!-- /头部 -->
代码本身的注释方法

单行代码的注释也保持同行,两端空格;多行代码的注释起始和结尾都另起一行并左缩进对齐。

1
2
3
4
5
6
7
<!-- <h1 class="m-logo"><a href="#">LOGO</a></h1> -->
<!--
<ul class="m-nav">
    <li><a href="#">NAV1</a></li>
    <li><a href="#">NAV2</a></li>
</ul>
-->
HTML注释在IE6中的BUG
  • 如果两个浮动元素之间存在注释,那么可能导致布局错位或文字的BUG。
  • 所以,这种情况下,我们通常将注释去掉,或者索性采用模板语言(ftl、vm)的注释。
严格的嵌套
  • 尽可能以最严格的xhtml strict标准来嵌套,比如内联元素不能包含块级元素等等。
  • 正确闭合标签且必须闭合。
严格的属性
  • 属性和值全部小写,每个属性都必须有一个值,每个值必须加双引号。
  • 没有值的属性必须使用自己的名称做为值(checked、disabled、readonly、selected等等)。
  • 可以省略style标签和script标签的type属性。
常用的标签
常见标签表
标签 语义 嵌套常见错误 常用属性(加粗的为不可缺少的或建议的)
<a></a> 超链接/锚 a不可嵌套a href,name,title,rel,target
<br /> 换行    
<button></button> 按钮 不可嵌套表单元素 type,disabled
<dd></dd> 定义列表中的定义(描述内容) 只能以dl为父容器,对应一个dt  
<del></del> 文本删除    
<div></div> 块级容器    
<dl></dl> 定义列表 只能嵌套dt和dd  
<dt></dt> 定义列表中的定义术语 只能以dl为父容器,对应多个dd  
<em></em> 强调文本    
<form></form> 表单   action,target,method,name
<h1></h1> 标题 从h1到h6,不可嵌套块级元素  
<iframe></iframe> 内嵌一个网页   frameborder,width,height,src,scrolling,name
<img /> 图像   alt,src,width,height
<input /> 各种表单控件   type,name,value,checked,disabled,maxlength,readonly,accesskey
<label></label> 标签为input元素定义标注   for
<li></li> 列表项 只能以ul或ol为父容器  
<link /> 引用样式或icon 不可嵌套任何元素 type,rel,href
<meta /> 文档信息 只用于head content,http-equiv,name
<ol></ol> 有序列表 只能嵌套li  
<option></option> select中的一个选项 仅用于select value,selected,disabled
<p></p> 段落 不能嵌套块级元素  
<script></script> 引用脚本 不可嵌套任何元素 type,src
<select></select> 列表框或下拉框 只能嵌套option或optgroup name,disabled,multiple
<span></span> 内联容器    
<strong></strong> 强调文本    
<style></style> 引用样式 不可嵌套任何元素 type,media
<sub></sub> 下标    
<sup></sup> 上标    
<table></table> 表格 只可嵌套表格元素 width,align,background,cellpadding,cellspacing,summary,border
<tbody></tbody> 表格主体 只用于table  
<td></td> 表格中的单元格 只用于tr colspan,rowspan
<textarea></textarea> 多行文本输入控件   name,accesskey,disabled,readonly,rows,cols
<tfoot></tfoot> 表格表尾 只用于table  
<th></th> 表格中的标题单元格 只用于tr colspan,rowspan
<thead></thead> 表格表头 只用于table  
<title></title> 文档标题 只用于head  
<tr></tr> 表格行 嵌套于table或thead、tbody、tfoot  
<ul></ul> 无序列表 只能嵌套li  

HTML规范 - 内容语义

内容类型决定使用的语义标签

在网页中某种类型的内容必定需要某种特定的HTML标签来承载,也就是我们常常提到的根据你的内容语义化HTML结构。

加强“资源型”内容的可访问性和可用性

在资源型的内容上加入描述文案,比如给img添加alt属性,在audio内加入文案和链接等等。

加强“不可见”内容的可访问性

背景图上的文字应该同时写在html中,并使用css使其不可见,有利于搜索引擎抓取你的内容,也可以在css失效的情况下看到内容。

适当使用实体

以实体代替与HTML语法相同的字符,避免浏览解析错误。

常用HTML字符实体(建议使用实体):
字符 名称 实体名 实体数
" 双引号 &quot; &#34;
& &符 &amp; &#38;
< 左尖括号(小于号) &lt; &#60;
> 右尖括号(大于号) &gt; &#62;
  空格 &nbsp; &#160;
  中文全角空格   &#12288;
常用特殊字符实体(不建议使用实体):
字符 名称 实体名 实体数
¥ &yen; &#165;
¦ 断竖线 &brvbar; &#166;
© 版权 &copy; &#169;
® 注册商标R &reg; &#174;
商标TM &trade; &#8482;
· 间隔符 &middot; &#183;
« 左双尖括号 &laquo; &#171;
» 右双尖括号 &raquo; &#187;
° &deg; &#176;
× &times; &#215;
÷ &divide; &#247;
千分比 &permil; &#8240;
本内容摘自网易开源项目nec中的HTML规范:http://nec.netease.com/standard/html-structure.html