HTML 编码规约

基本规约

  • 在每个 HTML 页面开头使用这个简单地 doctype 来启用标准模式,使其每个浏览器中尽可能一致的展现。
<!-- bad -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
  </head>
</html>

<!-- good -->
<!DOCTYPE html>
<html>
  <head>
  </head>
</html>
  • 统一使用 UTF-8 字符编码

  • Internet Explorer 支持使用兼容性 <meta> 标签来指定使用什么版本的 IE 来渲染页面。如果不是特殊需要,通常通过 edge mode 来通知 IE 使用最新的兼容模式。

<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
  • 根据 HTML5 规约, 通常在引入 CSS 和 JavaScript 时不需要指明 type,因为 text/css 和 text/javascript 分别是他们的默认值。
<!-- bad -->
<!DOCTYPE html>
<head>
  <link type="text/css" rel="stylesheet" href="code-guide.css">
  <script type="text/javascript" src="example.js"></script>
</head>

<!-- good -->
<!DOCTYPE html>
<head>
  <link rel="stylesheet" href="code-guide.css">
  <script src="example.js"></script>
</head>
  • 引入 CSS 必须在 <head></head> 标签里引入。对于引入 Javascript,除了基础库等比较基础性的脚本文件,其他都在靠近 body 结束标签前面引入。
<!-- bad -->
<!DOCTYPE html>
<html>
  <head>
    <script src="mod-a.js"></script>
    <script src="jquery.js"></script>
  </head>
  <body>
      <style>
          .mod-example {
              padding-left: 15px
          }
      </style>
  </body>
</html>

<!-- good -->
<!DOCTYPE html>
<html>
  <head>
    <style>
      .mod-example {
        padding-left: 15px
      }
    </style>
    <script src="jquery.js"></script>
  </head>
  <body>
  </body>
</html>
  • 【建议】缩进使用两个空格
<!-- bad -->
<div>
    <p>just a example</p>
</div>

<!-- good -->
<div>
  <p>just a example</p>
</div>
  • 标签名称和标签属性统一使用小写
<!-- bad -->
<Div Id="test">
</Div>

<!-- good -->
<div id="test">
</div>
  • 建议的 html 脚手架
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <meta lang="zh">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="renderer" content="webkit">
    <meta name="description" content="">
    <meta name="keyword" content="">
    <title>淘宝网</title>
    <link rel="stylesheet" href="example.css">
  </head>
  <body>
      <script src="example.js"></script>
  </body>
</html>

属性规约

  • 属性引号用双引号
<!-- bad -->
<link rel='stylesheet' href='example.css'>

<!-- good -->
<link rel="stylesheet" href="example.css">
  • 尽量不要为 Boolean 属性添加取值。
<!-- bad -->
<input type="text" disabled="disabled">

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

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

<!-- good -->
<input type="text" disabled>

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

<select>
  <option value="1" selected>1</option>
</select>
  • 建议自定义属性必须以 data- 为前缀,便于阅读。
<!-- bad -->
<a modal="toggle" href="#">
  Example link
</a>

<!-- good -->
<a data-modal="toggle" href="#">
  Example link
</a>
  • HTML 属性应该按照特定的顺序出现以保证易读性
    class
    id, name
    data-*
    ...
    Classes 是为高可复用组件设计的,所以他们处在第一位。Ids 更加具体而且应该尽量少使用(例如, 页内书签),所以他们处在第二位。
<!-- bad -->
<a href="#" data-modal="toggle" id="... class="..."">
  Example link
</a>

<input type="text" class="form-control">

<!-- good -->
<a class="..." id="..." data-modal="toggle" href="#">
  Example link
</a>

<input class="form-control" type="text">

标签规约

【建议】不要在自动闭合标签的结尾处使用斜线,如<br>、<hr>、<input>、<meta>、<source>

命名规约

  • 对于需要自定义属性,属性名命名统一使用 data- 前缀
  • id 命名,当作为 JS 钩子使用 时,以 J_ 为前缀,后面接大驼峰命名,且这类选择器不能出现在 css 中,例如 J_ExampleIdForJs。其他使用用法,例如充当锚点,label 对应 input 的 id,都正常默认使用即可。

多媒体退化

  • img标签添加alt 属性以声明替代文本;
  • 在多媒体标签内部提供指示浏览器不支持该标签的说明,如object、audio、video
<!-- bad -->
<audio controls>
  <source src="horse.ogg" type="audio/ogg">
  <source src="horse.mp3" type="audio/mpeg">
</audio>

<!-- good -->
<audio controls>
  <source src="horse.ogg" type="audio/ogg">
  <source src="horse.mp3" type="audio/mpeg">
  Your browser does not support the audio tag.
</audio>

注释规约

由于 html 代码一般不会经过预处理,出于安全考虑,html 代码中不能出现任何关于业务相关敏感信息的注释。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容