你必須了解的HTML規格(整理分享)

WBOY
發布: 2022-01-13 18:06:36
轉載
1800 人瀏覽過

這篇文章為大家帶來了HTML規範的相關知識HTML作為描述網頁結構的超文本標記語言,一直有著廣泛的應用。本文檔的目標是使HTML程式碼風格在內部開發能夠保持一致,使得專案更容易被理解和維護。希望對大家有幫助。

你必須了解的HTML規格(整理分享)

HTML 規格

1 前言

HTML作為描述網頁結構的超文本標記語言,一直有廣泛的應用。本文檔的目標是使HTML程式碼風格在內部開發能夠保持一致,使得專案更容易被理解和維護。

2 程式碼樣式

#2.1 縮排與換行

[強制] 使用4 個空格做為一個縮排層級,不允許使用2 個空格或tab 字元。

範例:

  • first
  • second
登入後複製

[建議] 每行不得超過 120 個字元。

解釋:

過長的程式碼不容易閱讀與維護。但考慮到 HTML 的特殊性,不做硬性要求。

2.2 命名

[強制] class 必須單字全字母小寫,單字間以 - 分隔。

[強制] class 必須代表對應模組或元件的內容或功能,不得以樣式資訊命名。

範例:


登入後複製

[強制] 元素 id 必須保證頁面唯一。

解釋:

同一個頁面中,不同的元素包含相同的 id,不符合 id 的屬性意義。並且使用 document.getElementById 時可能導致難以追蹤的問題。

[強制] id 建議單字全字母小寫,單字間以 - 分隔。同項目必須保持風格一致。

[建議] id、class 命名,在避免衝突並描述清楚的前提下盡可能短。

範例:






登入後複製

[強制] 禁止為了 hook 腳本,建立無樣式資訊的 class。

解釋:

不允許 class 只用於讓 JavaScript 選擇某些元素,class 應該有明確的語意和樣式。否則容易導致 css class 氾濫。

使用 id、屬性選擇作為 hook 是更好的方式。

[強制] 同一頁面,應避免使用相同的 name 與 id。

解釋:

IE 瀏覽器會混淆元素的 id 和 name 屬性, document.getElementById 可能會得到不期望的元素。所以在對元素的 id 與 name 屬性的命名需要非常小心。

一個比較好的實踐是,為 id 和 name 使用不同的命名法。

範例:


登入後複製

2.3 標籤

[強制] 標籤名稱必須使用小寫字母。

範例:


Hello StyleGuide!

Hello StyleGuide!

登入後複製

[強制] 對於無需自閉合的標籤,不允許自閉合。

解釋:

常見無需自閉合標籤有input、br、img、hr等。

範例:




登入後複製

[強制] 對 HTML5 中規定允許省略的閉合標籤,不允許省略閉合標籤。

解釋:

對程式碼體積要求非常嚴苛的場景,可以例外。例如:第三方頁面使用的投放系統。

範例:


  • first
  • second
  • first
  • second
登入後複製

[強制] 標籤使用必須符合標籤巢狀規則。

解釋:

例如 div 不得置於 p 中,tbody 必須置於 table 中。

詳細的標籤巢狀規則請參考HTML DTD中的 Elements 定義部分。

[建議] HTML 標籤的使用應該遵循標籤的語意。

解釋:

下面是常見標籤語意

  • p - 段落

  • h1,h2, h3,h4,h5,h6 - 層級標題

  • strong,em - 強調

  • ins - 插入

  • #del - 刪除

  • abbr - 縮寫

  • #code - 程式碼標識

cite - 引述來源作品的標題

q - 引用

blockquote - 一段或長篇引用

#ul - 無序列表

ol - 有序列表

#dl,dt,dd - 定義列表

範例:


Esprima serves as an important building block for some JavaScript language tools.

Esprima serves as an important building block for some JavaScript language tools.
登入後複製

[建議] 在CSS 可以實現相同需求的情況下不得使用表格進行佈局。

解釋:

在相容性允許的情況下應盡量保持語意正確性。對網格對齊和拉伸性有嚴格要求的場景允許例外,如多列複雜表單。

[建議] 標籤的使用應盡量簡潔,減少不必要的標籤。

範例:





    
登入後複製

2.4 屬性[強制] 屬性名稱必須使用小寫字母。

範例:


...
...
登入後複製
[強制] 屬性值必須用雙引號包圍(不包含iView、element等元件庫)。

解釋:######不允許使用單引號,不允許不使用引號。 ######範例:###




登入後複製
###[建議] 布林類型的屬性,建議不加入屬性值。 ######範例:###

登入後複製
###[建議] 自訂屬性建議以 xxx- 為前綴,建議使用 data-。 ######解釋:######使用前綴有助於區分自訂屬性和標準定義的屬性。 ######範例:###
    登入後複製
    #########3 通用################3.1 DOCTYPE######

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

    示例:

    登入後複製

    [建议] 启用 IE Edge 模式。

    示例:

    登入後複製

    [建议] 在 html 标签上设置正确的 lang 属性。

    解释:

    有助于提高页面的可访问性,如:让语音合成工具确定其所应该采用的发音,令翻译工具确定其翻译语言等。

    示例:

    登入後複製

    3.2 编码

    [强制] 页面必须使用精简形式,明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。

    解释:

    见 HTML5 Charset能用吗 一文。

    示例:

    
        
            
            ......
        
    
    ......
    登入後複製

    [建议] HTML 文件使用无 BOM 的 UTF-8 编码。

    解释:

    UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。

    3.3 CSS和JavaScript引入

    [强制] 引入 CSS 时必须指明 rel="stylesheet"。

    示例:

    登入後複製

    [建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。

    解释:

    text/css 和 text/javascript 是 type 的默认值。

    [建议] 展现定义放置于外部 CSS 中,行为定义放置于外部 JavaScript 中。

    解释:

    结构-样式-行为的代码分离,对于提高代码的可阅读性和维护性都有好处。

    [建议] 在 head 中引入页面需要的所有 CSS 资源。

    解释:

    在页面渲染的过程中,新的CSS可能导致元素的样式重新计算和绘制,页面闪烁。

    [建议] JavaScript 应当放在页面末尾,或采用异步加载。

    解释:

    将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必要,请遵守此条建议。

    示例:

    
        
        
    
    登入後複製

    [建议] 移动环境或只针对现代浏览器设计的 Web 应用,如果引用外部资源的 URL 协议部分与页面相同,建议省略协议前缀。

    解释:

    使用 protocol-relative URL 引入 CSS,在 IE7/8 下,会发两次请求。是否使用 protocol-relative URL 应充分考虑页面针对的环境。

    示例:

    登入後複製

    4 head

    4.1 title

    [强制] 页面必须包含 title 标签声明标题。

    [强制] title 必须作为 head 的直接子元素,并紧随 charset 声明之后。

    解释:

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

    示例:

    
        
        页面标题
    
    
    登入後複製

    4.2 favicon

    [强制] 保证 favicon 可访问。

    解释:

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

    • 在 Web Server 根目录放置 favicon.ico 文件。

    • 使用 link 指定 favicon。

    示例:

    登入後複製

    4.3 viewport

    [建议] 若页面欲对移动设备友好,需指定页面的 viewport。

    解释:

    viewport meta tag可以设置可视区域的宽度和初始缩放大小,避免在移动设备上出现页面展示不正常。

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

    另外,为了使 viewport 正常工作,在页面内容样式布局设计上也要做相应调整,如避免绝对定位等。关于 viewport 的更多介绍,可以参见 Safari Web Content Guide的介绍

    5 图片

    [强制] 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src。

    解释:

    src 取值为空,会导致部分浏览器重新加载一次当前页面,参考:developer.yahoo.com/performance…

    [建议] 避免为 img 添加不必要的 title 属性。

    解释:

    多余的 title 影响看图体验,并且增加了页面尺寸。

    [建议] 为重要图片添加 alt 属性。

    解释:

    可以提高图片加载失败时的用户体验。

    [建议] 添加 width 和 height 属性,以避免页面抖动。

    [建议] 有下载需求的图片采用 img 标签实现,无下载需求的图片采用 CSS 背景图实现。

    解释:

    • 产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片,以 img 形式实现,能方便用户下载。

    • 无下载需求的图片,比如:icon、背景、代码使用的图片等,尽可能采用 css 背景图实现。

    6 表单

    6.1 控件标题

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

    解释:

    有两种方式:

    • 将控件置于 label 内。

    • label 的 for 属性指向控件的 id。

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

    示例:

    
     
    登入後複製

    6.2 按钮

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

    解释:

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

    示例:

    
    
    登入後複製

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

    解释:

    由于浏览器兼容性问题,使用按钮的 name 属性会带来许多难以发现的问题。具体情况可参考此文。

    6.3 可访问性 (A11Y)

    [建议] 负责主要功能的按钮在 DOM 中的顺序应靠前。

    解释:

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

    示例:

    
    
    
    登入後複製

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

    解释:

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

    示例:

    登入後複製

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

    解释:

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

    示例:

    登入後複製

    7 多媒体

    [建议] 当在现代浏览器中使用 audio 以及 video 标签来播放音频、视频时,应当注意格式。

    解释:

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

    • MP3

    • WAV

    • Ogg

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

    • MP4

    • WebM

    • Ogg

    [建议] 在支持 HTML5 的浏览器中优先使用 audio 和 video 标签来定义音视频元素。

    [建议] 使用退化到插件的方式来对多浏览器进行支持。

    示例:

    
    
    登入後複製

    [建议] 只在必要的时候开启音视频的自动播放。

    [建议] 在 object 标签内部提供指示浏览器不支持该标签的说明。

    示例:

    DO NOT SUPPORT THIS TAG
    登入後複製

    8 模板中的 HTML

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

    示例:

    
    {if $display == true}
    
      {foreach $item_list as $item}
    • {$item.name}
    • {/foreach}
    {/if} {if $display == true}
      {foreach $item_list as $item}
    • {$item.name}
    • {/foreach}
    {/if}
    登入後複製

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

    示例:

    
    
  1. { $item.type_name }
  2. { $item.type_name }
  3. 登入後複製

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

    示例:

    
    
        {foreach $item_list as $item_group}
        
            {foreach $item_group as $item}
            
            {/foreach}
        
        {/foreach}
    
    { $item.name }
    {foreach $item_list as $item} {if $item@iteration is div by 5} {/if} {/foreach}
    { $item.name }
    登入後複製

    推荐教程:《html视频教程

    以上是你必須了解的HTML規格(整理分享)的詳細內容。更多資訊請關注PHP中文網其他相關文章!

    相關標籤:
    來源:juejin.im
    本網站聲明
    本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
    最新問題
    熱門教學
    更多>
    最新下載
    更多>
    網站特效
    網站源碼
    網站素材
    前端模板
    關於我們 免責聲明 Sitemap
    PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!