HTML 코딩 표준

藏色散人
藏色散人앞으로
2019-10-29 11:55:443317검색

HTML 코딩 표준

HTML 코딩 사양

이 문서의 목표는 HTML 코드 스타일을 일관되고 이해하고 유지하기 쉽게 만드는 것입니다. 이러한 습관이 없다면 IDE를 신중하게 선택하고 사용하지 마세요. "텍스트 편집" 장치".

1 코드 스타일

1.1 들여쓰기 및 줄 바꿈

[필수] 들여쓰기 수준으로 공백 4개를 사용하거나 공백 2개 또는 탭 문자는 허용되지 않습니다.

예:

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

[권장] 한 줄에 최대 120자입니다.

설명:

너무 긴 코드는 읽고 유지하기가 쉽지 않습니다. 그러나 HTML의 특수성을 고려하면 Sublime, phpstorm, wenstorm 등에는 모두 눈금자 기능이 있습니다.

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

[필수] 동일한 페이지에 동일한 이름과 ID를 사용하지 마세요.

설명:

IE 브라우저는 요소의 ID 및 이름 속성을 혼동하여 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 Tags

[필수] 태그 이름은 소문자를 사용해야 합니다.

예:

<!-- 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는 테이블에 배치해야 합니다.

예:

<!-- 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>building block</span> for some JavaScript language tools.</div>

[권장 사항] CSS가 동일한 요구 사항을 달성할 수 있는 경우 테이블을 레이아웃에 사용하면 안 됩니다.

설명:

호환성이 허용되는 한 의미론적 정확성이 최대한 유지되어야 합니다. 여러 열이 포함된 복잡한 양식과 같이 그리드 정렬 및 확장 가능성에 대한 엄격한 요구 사항이 있는 시나리오에는 예외가 허용됩니다.

[권장사항] 태그 사용은 최대한 간결하고 불필요한 태그를 줄여야 합니다.

예:

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

1.4 Properties

[필수] 속성 이름은 소문자를 사용해야 합니다.

예:

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

[권장 사항] Boolean 유형 속성의 경우 속성 값을 추가하지 않는 것이 좋습니다.

예:

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

2.1 DOCTYPE

[필수] 표준 모드를 ​​활성화하려면 HTML5의 doctype을 사용하세요. 대문자 DOCTYPE을 사용하는 것이 좋습니다.

예:

<!DOCTYPE html>

[권장] IE Edge 및 Chrome 프레임 모드를 활성화합니다.

예:

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

[제안] html 태그에 올바른 lang 속성을 설정하세요.

설명:

음성 합성 도구가 사용해야 하는 발음을 결정하도록 하고, 번역 도구가 번역 언어를 결정하도록 하는 등 페이지의 접근성을 개선하는 데 도움이 됩니다.

예:

<html>

[권장 사항] 렌더링을 위해 듀얼 코어 브라우저의 웹킷 커널을 활성화합니다.

설명:

브라우저 커널 제어 메타 태그 문서 문서를 참조하세요.

예:

<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 인코딩

[필수] 페이지는 압축된 형식을 사용해야 하며 문자 인코딩을 명시적으로 지정해야 합니다. 문자 인코딩을 지정하는 메타는 head의 첫 번째 직계 자식이어야 합니다.

설명:

HTML5 문자 집합을 사용할 수 있나요? 문서를 참조하세요.

예:

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

[권장] HTML 파일에 BOM-free UTF-8 인코딩을 사용하세요.

설명:

UTF-8 인코딩은 적응성이 더 넓습니다. BOM은 프로그램이나 도구를 사용하여 파일을 처리할 때 불필요한 간섭을 일으킬 수 있습니다.

2.3 CSS 및 JavaScript 소개

[필수] CSS 소개 시 rel="stylesheet"를 지정해야 합니다.

예:

<link rel="stylesheet" src="page.css">

[제안] CSS 및 JavaScript를 도입할 때 유형 속성을 지정할 필요가 없습니다.

解释:

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 的直接子元素,并紧随 8cb8652d9426d896d07c072f8c56c0c7 声明之后。

解释:

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
이 기사는 zuzuche.com에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제
이전 기사:HTML 코딩 규칙다음 기사:HTML 코딩 규칙