ホームページ  >  記事  >  ウェブフロントエンド  >  知っておくべきHTML仕様(整理・共有)

知っておくべきHTML仕様(整理・共有)

WBOY
WBOY転載
2022-01-13 18:06:361905ブラウズ

この記事では、HTML 仕様についての知識を提供します。HTML は、Web ページの構造を記述するハイパーテキスト マークアップ言語として、常に広く使用されています。このドキュメントの目的は、内部開発内で HTML コード スタイルの一貫性を確保し、プロジェクトの理解と保守を容易にすることです。みんなが助けてくれることを願っています。

知っておくべきHTML仕様(整理・共有)

#HTML 仕様

1 はじめに

HTML は、Web ページの構造を記述するハイパーテキスト マークアップ言語として、常に広く使用されています。このドキュメントの目的は、内部開発内で HTML コード スタイルの一貫性を確保し、プロジェクトの理解と保守を容易にすることです。

2 コードスタイル

2.1 インデントと改行

[必須] スペースは 4 つ使用しますインデント レベルとして機能し、2 つのスペースまたはタブ文字は許可されません。

例:

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

[推奨] 1 行あたり最大 120 文字。

説明:

コードが長すぎると、読んだり保守したりするのが難しくなります。ただし、HTML の特殊性を考慮すると、厳密な要件はありません。

2.2 命名

[必須] クラスにはすべて小文字を含める必要があり、単語は - で区切る必要があります。

[必須] クラスは、対応するモジュールまたはコンポーネントのコンテンツまたは関数を表す必要があり、スタイル情報を使用して名前を付けることはできません。

例:

<!-- good -->
<div></div>
<!-- bad -->
<div></div>

[必須] 要素 ID はページ上で一意である必要があります。

説明:

同じページ内の異なる要素に同じ ID が含まれていますが、これは ID の属性の意味に準拠していません。また、document.getElementById を使用すると、追跡が困難な問題が発生する可能性があります。

[必須] id 内のすべての単語を小文字にし、- で区切ることをお勧めします。スタイルは同じプロジェクト内で一貫している必要があります。

[推奨事項] ID とクラス名は、競合を避け、明確に記述しつつ、できるだけ短くする必要があります。

例:

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

[必須] フックスクリプトのスタイル情報を持たないクラスの作成は禁止されています。

説明:

クラスは許可されていません。JavaScript に特定の要素を選択させるためにのみ使用されます。クラスには明確なセマンティクスとスタイルが必要です。そうしないと、CSS クラスの急増につながりやすくなります。

ID と属性の選択をフックとして使用する方が良い方法です。

[必須] 同じページで同じ名前と ID を使用しないでください。

説明:

IE ブラウザは要素の id 属性と name 属性を混同し、document.getElementById が予期しない要素を取得する可能性があります。したがって、要素の id 属性と name 属性に名前を付けるときは十分に注意する必要があります。

ID と名前に異なる命名規則を使用することをお勧めします。

例:

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

2.3 タグ

[必須] タグ名には小文字を使用する必要があります。

例:

<!-- good -->
<p>Hello StyleGuide!</p>
<!-- bad -->
<P>Hello StyleGuide!</P>

[必須] 自己終了を必要としないラベルでは、自己終了は許可されません。

説明:

自己終了を必要としない一般的なタグには、input、br、img、hr などが含まれます。

例:

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

【必須】 HTML5では省略が認められている終了タグについて、終了タグの省略は認められません。

説明:

コード サイズに関する要件が非常に厳しいシナリオでは、例外が発生する可能性があります。例: サードパーティのページで使用される配信システム。

例:


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

  • first
  • second

[必須] タグの使用は、タグのネスト ルールに従う必要があります。

説明:

たとえば、div を p に配置することはできず、tbody を table に配置する必要があります。

タグのネスト ルールの詳細については、HTML DTD の「要素の定義」セクションを参照してください。

[推奨事項] HTML タグの使用は、タグのセマンティクスに従う必要があります。

説明:

以下は一般的なタグのセマンティクスです

  • 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>building block</span> for some JavaScript language tools.</div>
[推奨事項] CSS が同じ要件を達成できる場合、レイアウトにテーブルを使用しないでください。

説明:

互換性が許す限り、セマンティックな正確性を可能な限り維持する必要があります。複数の列を含む複雑なフォームなど、グリッドの配置と伸縮性に関する厳密な要件があるシナリオでは例外が許可されます。

[推奨事項] タグの使用はできる限り簡潔にし、不要なタグを減らす必要があります。

例:

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

2.4 プロパティ

[必須] プロパティ名には小文字を使用する必要があります。

例:

<!-- good -->
<table cellspacing="0">...</table>
<!-- bad -->
<table cellSpacing="0">...</table>

[必須] 属性値は二重引用符で囲む必要があります (iView や要素などのコンポーネント ライブラリを除く)。

説明:

一重引用符と引用符は使用できません。

例:

<!-- good -->
<script src="esl.js"></script>
<!-- bad -->
<script src=&#39;esl.js&#39;></script>
<script src=esl.js></script>

[提案] ブール型属性の場合は、属性値を追加しないことをお勧めします。

例:

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

[推奨事項] カスタム属性の先頭に xxx- を付けることをお勧めします。data- を付けることをお勧めします。

説明:

プレフィックスを使用すると、カスタム プロパティと標準定義のプロパティを区別するのに役立ちます。

例:

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

3 汎用

##3.1 DOCTYPE

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

示例:

<!DOCTYPE html>

[建议] 启用 IE Edge 模式。

示例:

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

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

解释:

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

示例:

<html>

3.2 编码

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

解释:

见 HTML5 Charset能用吗 一文。

示例:

<html>
    
        
        ......
    
    
        ......
    

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

解释:

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

3.3 CSS和JavaScript引入

[强制] 引入 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="//s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>

4 head

4.1 title

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

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

解释:

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

示例:

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

4.2 favicon

[强制] 保证 favicon 可访问。

解释:

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

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

  • 使用 link 指定 favicon。

示例:

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

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 结构不允许直接嵌套,则应使用第二种。

示例:

<label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label>
<label for="username">用户名:</label> <input type="textbox" name="username" id="username">

6.2 按钮

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

解释:

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

示例:

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

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

解释:

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

6.3 可访问性 (A11Y)

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

解释:

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

示例:

<!-- good -->
<style>
.buttons .button-group {
    float: right;
}
</style>
<div>
    <div>
        <button type="submit">提交</button>
        <button type="button">取消</button>
    </div>
</div>
<!-- bad -->
<style>
.buttons button {
    float: right;
}
</style>
<div>
    <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">

7 多媒体

[建议] 当在现代浏览器中使用 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>

8 模板中的 HTML

[建议] 模板代码的缩进优先保证 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}{/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 $item@iteration is div by 5}
    </tr>
    <tr>
        {/if}
    {/foreach}
</tr>
</table>

推荐教程:《html视频教程

以上が知っておくべきHTML仕様(整理・共有)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事はjuejin.imで複製されています。侵害がある場合は、admin@php.cn までご連絡ください。