HTML/CSS代码编写规范·前言

超文本标记语言或超文本链接标示语言(标准通用标记语言下的一个应用)HTML(HyperText Mark-up Language)是一种制作万维网页面的标准语言,是万维网浏览器使用的一种语言,它消除了不同计算机之间信息交流的障碍。作为描述网页结构的超文本标记语言,在互联网应用广泛。本文的目标是使HTML代码风格保持一致,容易被理解和被维护,方便编写出灵活、稳定、高质量的 HTML/CSS 的代码。

HTML-CSS-Simple-Specification

规范目的:

不管有多少人共同参与同一项目,确保每一行代码都像是同一个人编写的。

HTML/CSS代码编写风格

基础规范

[强烈建议]放弃使用绝对地址(绝对路径),统一使用(//)相对协议头(相对路径)以简单兼容HTTP的新老协议(http://和https)。
解释:IETF于2015-02-18发布了正式版的HTTP2协议,你的项目还停留在使用了16年的HTTP1.1协议版本?不考虑协议兼容?除非页面使用http/https无法获取到资源,必须使用其它协议才能获取到资源的,就不能省略(绝对路径),这样理解:页面使用http://或者https://是可以使用(//)兼容两者的全部特效,使得网站页面同时支援http/https的访问。
示例:

<link rel='stylesheet' id='style-css' href='//www.9sep.org/wp-content/themes/9sep/style.css' type='text/css' media='all'/>
<script src='//www.9sep.org/wp-includes/js/jquery/jquery-migrate.min.js'></script>
<img src="//www.9sep.org/wp-content/uploads/2014/07/logo.png"/>
<a href="//www.9sep.org/">九秒分享</a>

[强制] 使用 HTML5 的 doctype 来启用标准模式,建议使用大写的 DOCTYPE。
示例:

<!DOCTYPE html>

[建议] 启用 IE Edge 模式。
示例:

<meta http-equiv="X-UA-Compatible" content="IE=Edge">

[建议] 在 html 标签上设置正确的 lang 属性。
解释:有助于提高页面的可访问性,如:让语音合成工具确定其所应该采用的发音,令翻译工具确定其翻译语言等。
示例:

<html lang="zh-CN">

编码

[强制] 明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素,当然服务器端设置charset也是很不错的做法,charset声明直接在HTTP response中获得,效率更高,而且更方便。Google目前在用这种方法。
解释:charset不规范化的写法会出现乱码。

示例:

<html>
    <head>
        <meta charset="UTF-8">
        ......
    </head>
    <body>
        ......
    </body>
</html>

[建议] HTML/CSS文档使用无 BOM 的 UTF-8 编码。
解释:UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。
[强制] 引入 CSS 时必须指明 rel=”stylesheet”。
示例:

<link rel="stylesheet" src="page.css">

[建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。
解释:text/css 和 text/javascript 是 type 的默认值。

[建议] 展现定义放置于外部 CSS 中,行为定义放置于外部 JavaScript 中。
解释:结构-样式-行为的代码分离,对于提高代码的可阅读性和维护性都有好处。
[建议] 在 head 中引入页面需要的所有 CSS 资源。
解释:在页面渲染的过程中,新的CSS可能导致元素的样式重新计算和绘制,页面闪烁。
[建议] JavaScript 应当放在页面末尾,或采用异步加载。
解释:将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必要,请遵守此条建议。

示例:

<body>
    <!-- a lot of elements -->
    <script src="init-behavior.js"></script>
</body>

[建议] 移动环境或只针对现代浏览器设计的 Web 应用,如果引用外部资源的 URL 协议部分与页面相同,建议省略协议前缀。
解释:使用 protocol-relative URL 引入 CSS,在 IE7/8 下,会发两次请求。是否使用 protocol-relative URL 应充分考虑页面针对的环境。

示例:

<script src="//www.9sep.org/wp-includes/js/jquery/jquery.js"></script>

缩进与换行

[强制] 使用 4 个空格做为一个缩进层级,不尾随空格,不要使用制表符(Tab)键。
解释:这是唯一能保证代码在所有环境下获得一致性展现的方法。
推荐:在块状元素,列表,表格元素后面使用新行,并且对它的子元素进行缩进。
示例:

<ul>
    <li>first</li>
    <li>second</li>
</ul>

建议:每行代码不超过 120 个字符。
解释:过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性,不做硬性要求。

属性命名与顺序

[强制]属性的命名必须代表相应模块或部件的内容或功能,绝不以样式信息进行命名。
[强制]对于属性的定义,确保全部使用双引号,绝不使用单引号。属性命名必须单词全字母小写,单词间以【-】分隔。
解释:标签/属性的命名用于直观了解相应模块的功能,请使用明确的名称。
示例:

<!-- good -->
<div class="sidebar"></div>
<!-- bad -->
<div class="left"></div>

[强制] 确保页面中的属性名称唯一。
建议: id、name、class 命名,在避免冲突并描述清楚的前提下尽可能短。
解释:同一个页面中,不同的元素包含相同的 id,不符合 id 的属性含义。并且使用 document.getElementById 时将导致异常。IE 浏览器会混淆元素的 id 和 name 属性, document.getElementById 可能获得不期望的元素。所以在对元素的 id 与 name 属性的命名需要非常小心,为 id 和 name 使用不同的命名避免这个麻烦。
示例:

<!-- good -->
<div id="nav"></div>
<!-- bad -->
<div id="navigation"></div>

<!-- good -->
<p class="comment"></p>
<!-- bad -->
<p class="com"></p>

<!-- good -->
<span class="author"></span>
<!-- bad -->
<span class="red"></span>
[建议]属性应该按照特定的顺序出现以提高易读性。
  • class
  • id, name
  • data-*
  • src, for, type, href
  • title, alt
  • aria-*, role

解释:Classes 是为高可复用组件设计的,所以它处在第一位。Ids 更加具体而且应该尽量少使用(例如, 页内书签),所以它们俩处在第二位。
[强制] 禁止为了 hook 脚本,创建无样式信息的 class。
解释:不允许 class 只用于让 JavaScript 选择某些元素,class 应该具有明确的语义和样式。否则容易导致 css class 泛滥。使用 id、属性选择作为 hook 是更好的方式。
示例:

<input name="foo">
<div id="foo"></div>
<script>
// IE6 将显示 INPUT
alert(document.getElementById('foo').tagName);
</script>

规范标签

[强制] 标签名称必须使用小写字母。
[强制] 正确区分自闭合元素和非自闭合元素,对于无需自闭合的标签,别自闭合。
[常见错误]:非法闭合包括:<br>..</br>、<script />、<iframe />, 非法闭合会导致页面嵌套错误问题。

解释:常见无需自闭合标签有input、br、img、hr等,不要画蛇添足。
示例:

<!-- good -->
<input type="text" name="title">

<!-- bad -->
<input type="text" name="title" />

[强制] 对于HTML5 中规定允许省略的闭合标签,不允许省略闭合标签。
说明:除非对代码体积要求非常严苛的场景,比如:第三方页面使用的投放系统。可以省略闭合标签减少代码体积。

示例:

<!-- good -->
<ul>
    <li>first</li>
    <li>second</li>
</ul>

<!-- bad -->
<ul>
    <li>first
    <li>second
</ul>

[强制] 标签使用必须符合标签嵌套规则。
解释:HTML 标签的使用应该遵循标签的语义。比如 div 不得置于 p 中,tbody 必须置于 table 中。
下面是常见标签语义

  • p – 段落
  • h1,h2,h3,h4,h5,h6 – 层级标题
  • strong,em – 强调
  • ins – 插入
  • del – 删除
  • abbr – 缩写
  • code – 代码标识
  • cite – 引述来源作品的标题
  • q – 引用
  • blockquote – 一段或长篇引用
  • ul – 无序列表
  • ol – 有序列表
  • dl,dt,dd – 定义列表

示例:

<!-- good -->
<p>Esprima serves as an important <strong>building block</strong> for some JavaScript language tools.</p>

<!-- bad -->
<div>Esprima serves as an important <span class="strong">building block</span> for some JavaScript language tools.</div>

建议: 在编写 HTML 代码时,需要尽量避免多余的父节点。很多时候,需要通过迭代和重构来使 HTML 变得更少,在 CSS 可以实现相同需求的情况下不得使用表格进行布局。
解释:减少不必要的标签,在兼容性允许的情况下应尽量保持语义正确性以保持简洁,对网格对齐和拉伸性有严格要求的场景允许例外,如多列复杂表单。

示例:

<!-- good -->
<img class="avatar" src="image.png">

<!-- bad -->
<span class="avatar">
    <img src="image.png">
</span>

明确属性

建议: 布尔(Boolean)类型的属性,建议不添加属性值。
解释:XHTML 需要每个属性声明取值,但是 HTML/HTML5 并不需要。
示例:

<input type="text" disabled>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>

建议: 自定义属性建议以 xxx- 为前缀,推荐使用 data-。
解释: 使用前缀有助于区分自定义属性和标准定义的属性。
示例:

<ol data-ui-type="Select"></ol>

常见一些编写规范

[强制] 页面必须包含 title 标签声明标题, title 必须作为 head 的直接子元素,并紧随编码声明(charset)之后。

解释:title 标签中如果包含 ascii 之外的字符,浏览器需要知道字符编码类型才能进行解码,否则可能导致乱码。

示例:

<head>
    <meta charset="UTF-8">
    <title>页面标题</title>
</head>

[强制] 保证页面指定的 favicon(网站/网页图标) 可访问。

解释:在未指定 favicon 时,大多数浏览器会默认请求网站根目录下的 favicon.ico 。为了保证favicon可访问,避免404,必须遵循以下两种方法之一:

1.在网站根目录下放置 favicon.ico 文件。
2.使用 link 自行指定 favicon.ico 所在的位置。
示例:

<link rel="shortcut icon" href="path/to/favicon.ico">

建议: 创建移动设备友好的页面,需指定页面的 viewport。

解释:元(Meta)标签中viewport可以通过设置不同的可视区域的宽度和初始缩放大小,避免网页在不同移动设备上出现页面展示不正常。

比如,在页面宽度小于 980px 时,若需 iOS 设备友好,应当设置 viewport 的 width 值来适应你的页面宽度。同时因为不同移动设备分辨率不同,在设置时,应当使用 device-width 和 device-height 变量。

另外,为了使 viewport 正常工作,在页面内容样式布局设计上也要做相应调整,推荐使用相对大小,相对定位等相对性的定义避免绝对定义。

[强制] 禁止 图片标签(Img)的 src 取值为空。使用延迟加载的图片也应增加默认的 src,不要为img标签添加 title 属性。

解释:当src取空值时,会导致部分浏览器出现重新加载(刷新)一次当前页面的情况,多余的 title 影响看图体验,增加了页面代码冗余。

建议: 添加 width 和 height 属性,以避免页面抖动。为重要图片添加 alt 属性。

解释:有下载需求的图片采用 img 标签实现,无下载需求的图片采用 CSS 背景图实现。可以减少网络请求提高页面加载速度,提高图片加载失败时的用户体验,间接对网站进行叻SEO(搜索引擎优化)

大致情景:用户头像、用户产生、产品 logo等图片以及具有潜在下载需求的图片,以 img 标签形式实现,方便用户下载。一些无下载需求的图片,比如:icon、背景、按钮中使用的图片等,尽可能采用 css 背景图或者CSS雪碧图(CSS Image Sprites)的方式实现。

[强制] 有文本标题的表单控件必须使用 label 标签将其与其标题相关联。

解释:

常见有以下两种方式:

  • 将控件置于 label 内。
  • label 的 for 属性指向控件的 id。

 

推荐使用第一种,减少不必要的 id。如果 DOM 结构不允许直接嵌套,则应使用第二种。

示例:

<label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label>

<label for="username">用户名:</label> <input type="textbox" name="username" id="username">

[强制] 使用按钮(button)元素时必须指明 type 属性值。

解释:button 元素的默认 type 为 submit,如果被置于 form 元素中,点击后将提交表单。为了显示区分其作用方便理解,应给出 type 属性。

示例:

<button type="submit">提交</button>
<button type="button">取消</button>

建议: 尽量不使用按钮类元素的 name 属性。

解释:由于浏览器兼容性问题,使用按钮的 name 属性会带来许多难以发现的问题。

建议:协调页面功能可访问性,负责主要功能的按钮在 DOM 中的顺序应靠前。

解释:负责主要功能的按钮应相对靠前,以提高可访问性。如果在 CSS 中指定了 float: right 则可能导致视觉上主按钮在前,而 DOM 中主按钮靠后的情况。

示例:

<!-- good -->
<style>
.buttons .button-group {
    float: right;
}
</style>

<div class="buttons">
    <div class="button-group">
        <button type="submit">提交</button>
        <button type="button">取消</button>
    </div>
</div>

<!-- bad -->
<style>
.buttons button {
    float: right;
}
</style>

<div class="buttons">
    <button type="button">取消</button>
    <button type="submit">提交</button>
</div>

建议: 当使用 JavaScript 进行表单提交时,如果条件允许,应使原生提交功能正常工作。

解释:当浏览器 JS 运行错误或关闭 JS 时,提交功能将无法工作。如果正确指定了 form 元素的 action 属性和表单控件的 name 属性时,提交仍可继续进行。

示例:

<form action="/login" method="post">
    <p><input name="username" type="text" placeholder="用户名"></p>
    <p><input name="password" type="password" placeholder="密码"></p>
</form>

建议: 在针对移动设备开发的页面时,根据内容类型指定输入框的 type 属性。

解释:

根据内容类型指定输入框类型,能获得能友好的输入体验。

示例:

<input type="date">

建议: 当在现代浏览器中使用 audio 以及 video 标签来播放音频、视频等多媒体资源时,应当注意格式。

解释:音频应尽可能覆盖到如下格式:

  • MP3
  • WAV
  • Ogg

视频应尽可能覆盖到如下格式:

  • MP4
  • WebM
  • Ogg

建议: 在支持 HTML5 的浏览器中优先使用 audio 和 video 标签来定义音视频元素。使用退化到插件的方式实现来对多浏览器进行支持。

示例:

<audio controls>
    <source src="audio.mp3" type="audio/mpeg">
    <source src="audio.ogg" type="audio/ogg">
    <object width="100" height="50" data="audio.mp3">
        <embed width="100" height="50" src="audio.swf">
    </object>
</audio>

<video width="100" height="50" controls>
    <source src="video.mp4" type="video/mp4">
    <source src="video.ogg" type="video/ogg">
    <object width="100" height="50" data="video.mp4">
        <embed width="100" height="50" src="video.swf">
    </object>
</video>

建议: 在 object 标签内部提供指示浏览器不支持该标签的说明。只在必要的时候开启音视频的自动播放。

示例:

<object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</object>

建议: 模板代码的缩进优先保证 HTML 代码的缩进规则。

示例:

<!-- good -->
{if $display == true}
<div>
    <ul>
    {foreach $item_list as $item}
        <li>{$item.name}<li>
    {/foreach}
    </ul>
</div>
{/if}

<!-- bad -->
{if $display == true}
    <div>
        <ul>
    {foreach $item_list as $item}
        <li>{$item.name}<li>
    {/foreach}
        </ul>
    </div>
{/if}

建议: 模板代码应以保证 HTML 单个标签语法的正确性为基本原则。
示例:

<!-- good -->
<li class="{if $item.type_id == $current_type}focus{/if}">{ $item.type_name }</li>

<!-- bad -->
<li {if $item.type_id == $current_type} class="focus"{/if}>{ $item.type_name }</li>

建议:在循环处理模板数据构造表格时,若要求每行输出固定的个数,建议先将数据分组,之后再循环输出。
示例:

<!-- good -->
<table>
    {foreach $item_list as $item_group}
    <tr>
        {foreach $item_group as $item}
        <td>{ $item.name }</td>
        {/foreach}
    <tr>
    {/foreach}
</table>

<!-- bad -->
<table>
<tr>
    {foreach $item_list as $item}
    <td>{ $item.name }</td>
        {if [email protected] is div by 5}
    </tr>
    <tr>
        {/if}
    {/foreach}
</tr>
</table>

结语:

简单实用高于不切实际的完美

尽量遵循 HTML 标准和语义,但是不应该以浪费实用性作为代价。任何时候都要用尽量小的复杂度和尽量少的标签来解决问题!

comment-author avatars

Zhys

Cherish the time! Don't waste even nine seconds to remember the past, live in the present and for the future planning.

猜你喜欢...