HTML のコーディング規約の詳細については、こちらをご覧ください。-htmlチュートリアル-php.cn

HTML のコーディング規約の詳細については、こちらをご覧ください。

このドキュメントの目標は、HTML コードスタイルに一貫性を持たせ、理解と保守を容易にすることです。この習慣がない場合は、IDE を慎重に選択し、使用しないでください。「テキスト」エディタを使用してください。

1 コードスタイル

1.1 インデントと改行

[必須] 4# を使用します## スペースはインデントレベルとして使用されます。2 スペースや tab 文字は使用できません。

例:

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

ログイン後にコピー

[推奨事項] 各行は 120 文字を超えてはなりません。

説明:

コードが長すぎると、読んだり保守したりするのが難しくなります。ただし、HTML の特殊性を考慮すると、厳密な要件はなく、Sublime、phpstorm、wenstorm などにはルーラー機能が備わっています。

1.2 名前付け

[必須] class すべての単語は小文字で、単語の間に ## を入れる必要があります。 #- 分離されました。

[必須]

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

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

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

ログイン後にコピー

[必須] 要素

id はページ上で一意である必要があります。説明:

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

[提案]

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

[推奨事項]

id、class 名前は、競合を避け、明確に説明しながら、できるだけ短くする必要があります。例:

<!-- 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>

ログイン後にコピー

[必須] 同じページで同じ

name と 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>

ログイン後にコピー

1.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 に配置する必要があります。

例:

<!-- good -->
<div><h1><span></span></h1></div>
<a href=""><span></span></a>


<!-- bad -->
<span><div></div></span>
<p><div></div></p>
<h1><div></div></h1>
<h6><div></div></h6>
<a href="a.html"><a href="a.html"></a></a>

ログイン後にコピー

[提案]

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 class="strong">building block</span> for some JavaScript language tools.
</div>

ログイン後にコピー

CSS

が同じ要件を達成できる場合、レイアウトにテーブルを使用しないでください。。

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

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

例:

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

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

ログイン後にコピー

1.4 属性

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

例:

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

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

ログイン後にコピー

[必須] 属性値は二重引用符で囲む必要があります。

説明:

一重引用符は使用できず、引用符も使用できません。

例:

<!-- good -->
<script src="esl.js"></script>

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

ログイン後にコピー

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

例:

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

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

ログイン後にコピー

[推奨事項] カスタム属性には、接頭辞として

xxx-

および

data-

を付けることをお勧めします。がおすすめ。。 説明: プレフィックスを使用すると、カスタムプロパティと標準定義のプロパティを区別するのに役立ちます。

例:

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

ログイン後にコピー

2 汎用

2.1 DOCTYPE

[必須] 使用HTML5 の

doctype

で標準モードを有効にするには、大文字の DOCTYPE を使用することをお勧めします。 例: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:html;toolbar:false"><!DOCTYPE html></pre><div class="contentsignin">ログイン後にコピー</div></div>[推奨] IE Edge および Chrome Frame モードを有効にします。＃＃＃＃＃＃＃＃＃例：＃＃＃

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

ログイン後にコピー

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

解释：

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

示例：

<html lang="zh-CN">

ログイン後にコピー

[建议] 开启双核浏览器的 webkit 内核进行渲染。

解释：

见浏览器内核控制Meta标签说明文档一文。

示例：

<meta name="renderer" content="webkit">

ログイン後にコピー

[建议] 开启浏览器的DNS预获取。

解释：

减少DNS请求次数、对DNS进行预获取。

示例：

<link rel="dns-prefetch" href="//global.zuzuche.com/">
<link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/">
<link rel="dns-prefetch" href="//qiniucdn.com/">

ログイン後にコピー

2.2 编码

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

解释：

见 HTML5 Charset能用吗一文。

示例：

<html lang="zh-CN">
    
        
        ......
    

    
        ......

ログイン後にコピー

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

解释：

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

2.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>

ログイン後にコピー

[强制] 引用静态资源的 URL 协议部分与页面相同，建议省略协议前缀。

示例：

<script src="//global.zuzuche.com/assets/js/gallery/jquery/1.11.2/jquery.js"></script>

ログイン後にコピー

3 Head

3.1 title

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

[强制] title 必须作为 head 的直接子元素，并紧随 <link rel="dns-prefetch"> 声明之后。

解释：

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

示例：

<head>
    <meta charset="UTF-8">
    <link rel="dns-prefetch" href="//global.zuzuche.com/">
    <link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/">
    <link rel="dns-prefetch" href="//qiniucdn.com/">
    <title>页面标题</title>
</head>

ログイン後にコピー

4 图片

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

解释：

src 取值为空，会导致部分浏览器重新加载一次当前页面，参考：https://developer.yahoo.com/performance/rules.html#emptysrc

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

解释：

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

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

解释：

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

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

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

解释：

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

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

5 表单

5.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">

ログイン後にコピー

5.2 按钮

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

解释：

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

示例：

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

ログイン後にコピー

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

解释：

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

5.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">
<input type="tel">
<input type="number">
<input type="number" pattern="\d*">

ログイン後にコピー

6 模板中的 HTML

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

示例：

<!-- good -->
<!-- IF is_display -->
<div>
    <ul>
        <!-- BEGIN item_list -->
        <li>{name}<li>
        <!-- END item_list -->
    </ul>
</div>
<!-- ENDIF item_list -->

<!-- bad -->
<!-- IF is_display -->
    <div>
        <ul>
    <!-- BEGIN item_list -->
        <li>{$item.name}<li>
    <!-- END item_list -->
        </ul>
    </div>
<!-- ENDIF item_list -->

ログイン後にコピー

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

示例：

<!-- good -->
<li class="<!-- IF selected --> selected<!-- ENDIF selected -->">{type_name}</li>

<!-- bad -->
<li <!-- IF selected --><!-- ENDIF selected -->>{type_name}</li>

ログイン後にコピー

[建议] 模板代码应以保证结束符的闭合名

示例：

<!-- good -->
<!-- IF is_display -->
<div>
    <!-- BEGIN item_list -->
    <ul>
        <!-- BEGIN package_list -->
        <li>
            <span>{name}：</span><span>￥{unit_price}</span>
        <li>
        <!-- END package_list -->
    </ul>
    <!-- END item_list -->
</div>
<!-- ENDIF is_display -->

<!-- bad -->
<!-- IF is_display -->
<div>
    <!-- BEGIN item_list -->
    <ul>
        <!-- BEGIN package_list -->
        <li>
            <span>{name}：</span><span>￥{unit_price}</span>
        <li>
        <!-- END -->
    </ul>
    <!-- END -->
</div>
<!-- ENDIF -->

ログイン後にコピー

[建议] 在循环处理模板数据构造表格时，若要求每行输出固定的个数，建议先将数据分组，之后再循环输出，模板只是做数据展示，别加插太多业务逻辑（其他数据构造同理）。

示例：

<!-- good -->
<table>
    <!-- BEGIN item_list -->
    <tr>
        <!-- BEGIN package_list -->
        <td>
            <span>{name}：</span><span>￥{unit_price}</span>
        </td>
        <!-- END package_list -->
    <tr>
    <!-- END item_list -->
</table>

<!-- bad -->
<table>
<tr>
    <!-- BEGIN item_list -->
    <td>
        <span>{name}：</span><span>￥{unit_price}</span>
    </td>
        <!-- IF id="5" -->
    </tr>
    <tr>
        <!-- ENDIF id -->
    <!-- END item_list -->
</tr>
</table>

<!-- good -->
<table>
    <!-- BEGIN item_list -->
    <tr>
        <!-- BEGIN package_list -->
        <td>
            <span>{name}：</span><span>￥{price}</span>
        </td>
        <!-- END package_list -->
    <tr>
    <!-- END item_list -->
</table>

<!-- bad -->
<table>
<!-- BEGIN item_list -->
<tr>
    <td>
        <span>{name}：</span>
        <!-- IF type="unit" -->
        <span>￥{unit_price}</span>
        <!-- ELSEIF type="total" -->
        <span>￥{total_price}</span>
        <!-- ENDIF type -->
    </td>
</tr>
<!-- END item_list -->
</tr>
</table>

ログイン後にコピー

以上がHTML のコーディング規約の詳細については、こちらをご覧ください。の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。