文章内容

2017/7/24 15:59:02,作 者: 黄兵

HTML规范

1 前言

本文档的目标是使HTML代码风格保持一致,容易被理解和被维护。

2 文件

2.1 文件编码

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

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

2.2 文件名

强制:创建 HTML 文件名要语义化。

解释:好的语义化文件名,方便查找。用单词命名,多个单词用"_"下划线拼接。

示例:

index.html //首页
article.html //文章页
details.html //详情页
personal_member.html //个人会员页
business_member.html //商户会员页
3 代码风格

3.1 命名

建议: 命名 要语义化。

解释:好的语义化命名,方便查找。命名尽量用单词、缩写语义化命名,多个单词用"-"中划线拼接。

<!-- CSS选择器命名 -->
<div class="goods">商品</div>
<div class="goods-list">商品列表</div>

<!-- data-* 自定义属性命名 -->
<div class="goods" data-goodsId="1">商品</div> //驼峰
<div class="goods" data-goods-id="1">商品</div> //中划线

<!-- js 自定义ID命名 -->
<div id="js-goods">商品</div> /* 获取DOM的ID */
<div id="js-goodsText">矿泉水</div> //获取文本值
<div id="js-goodsVal">矿泉水</div> //获取value值

3.2 缩进

强制:使用 4 个空格做为一个缩进层级,不允许使用 2 个空格。

示例:

<div>
    <ul>
        <li>测试</li>
    </ul>
</div>
4 引入文件

4.1 css文件

建议: 在引入 CSS 文件时一般不需要指定 type 属性, 因为 text/css 是默认值。

<link rel="stylesheet" href="style.css">

4.2 JS文件

建议: 在引入 JS 文件时一般不需要指定 type 属性, 因为 text/javascript 是默认值。

<script src="test.js"></script>
分享到:

发表评论

评论列表