html编写规范

HTML编码规范

首先是使HTML代码风格保持一致,容易被理解,

  • 1 代码风格
    • 1.1 缩进与换行
      使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符,每行不得超过 120 个字符。因为过长的代码不容易阅读与维护。
    • 1.2 命名
      class 必须单词全字母小写,单词间以 - 分隔。
      class 必须代表相应模块或部件的内容或功能,不得以样式信息进行命名。
    • 1.3 标签
      标签名必须使用小写字母。
      对于无需自闭合的标签,不允许自闭合。
      常见无需自闭合标签有input、br、img、hr等。
      对 HTML5 中规定允许省略的闭合标签,不允许省略闭合标签。
      标签使用必须符合标签嵌套规则。
      比如 div 不得置于 p 中,tbody 必须置于 table 中。
      HTML 标签的使用应该遵循标签的语义。
      • 下面是常见标签语义
        p - 段落
        h1,h2,h3,h4,h5,h6 - 层级标题
        strong,em - 强调
        ins - 插入
        del - 删除
        abbr - 缩写
        code - 代码标识
        cite - 引述来源作品的标题
        q - 引用
        blockquote - 一段或长篇引用
        ul - 无序列表
        ol - 有序列表
        dl,dt,dd - 定义列表
        在 CSS 可以实现相同需求的情况下不得使用表格进行布局。
        在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格要求的场景允许例外,如多列复杂表单。
        标签的使用应尽量简洁,减少不必要的标签。
    • 1.4 属性
      属性名必须使用小写字母。
      属性值必须用双引号包围。
      不允许使用单引号,不允许不使用引号。
      布尔类型的属性,建议不添加属性值。
      自定义属性建议以 xxx- 为前缀,推荐使用 data-。
      使用前缀有助于区分自定义属性和标准定义的属性。
  • 2
    • 2.1 DOCTYPE
      使用 HTML5 的 doctype 来启用标准模式,建议使用大写的 DOCTYPE。
      启用 IE Edge 和 Chrome Frame 模式。
      在 html 标签上设置正确的 lang 属性。
      有助于提高页面的可访问性,如:让语音合成工具确定其所应该采用的发音,令翻译工具确定其翻译语言等。
    • 2.2 编码
      页面必须使用精简形式,明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。
    • 2.3 CSS和JavaScript引入
      引入 CSS 时必须指明 rel="stylesheet"。
      引入 CSS 和 JavaScript 时无须指明 type 属性。
      text/css 和 text/javascript 是 type 的默认值。
  • 3 Head
    • 3.1 title
      页面必须包含 title 标签声明标题。
      title 必须作为 head 的直接子元素,并紧随 声明之后。
      title 中如果包含 ascii 之外的字符,浏览器需要知道字符编码类型才能进行解码,否则可能导致乱码。
  • 4 图片
    禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src。
    src 取值为空,会导致部分浏览器重新加载一次当前页面, 避免为 img 添加不必要的 title 属性。
    多余的 title 影响看图体验,并且增加了页面尺寸。
    为重要图片添加 alt 属性。
    可以提高图片加载失败时的用户体验。
    添加 width 和 height 属性,以避免页面抖动。
    有下载需求的图片采用 img 标签实现,无下载需求的图片采用 CSS 背景图实现。
    产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片,以 img 形式实现,能方便用户下载。
    无下载需求的图片,比如:icon、背景、代码使用的图片等,尽可能采用 css 背景图实现。
  • 5 表单
    • 5.1 控件标题
      有文本标题的控件必须使用 label 标签将其与其标题相关联。
      有两种方式:
      将控件置于 label 内。
      label 的 for 属性指向控件的 id。
    • 5.2 按钮
      使用 button 元素时必须指明 type 属性值。
      button 元素的默认 type 为 submit,如果被置于 form 元素中,点击后将导致表单提交。为显示区分其作用方便理解,必须给出 type 属性。
      尽量不要使用按钮类元素的 name 属性。
      由于浏览器兼容性问题,使用按钮的 name 属性会带来许多难以发现的问题。
  • 6 模板中的 HTML
    模板代码的缩进优先保证 HTML 代码的缩进规则。
    模板代码应以保证 HTML 单个标签语法的正确性为基本原则。
    模板代码应以保证结束符的闭合名
原文地址:https://www.cnblogs.com/MXLei1/p/6931380.html