前端工程师样式指南 - HTML

前端工程师样式指南 - HTML

一般格式规则

字母大小写

仅使用小写。
所有代码均使用小写,该规则适用于 HTML 元素名、属性和属性值(文本/ CDATA 除外)。

不推荐:

<A HREF="/">主页</A>

推荐:

<a href="/">主页</a>

末尾空白

删除行尾空格。
行尾空格属于多余的符号,会使 diff 更加难以阅读。

不推荐:

<p>什么?</p>__

推荐:

<p>一往情深深几许?深山夕照深秋雨。</p>

如果使用 Sublime Text,你可在用户设置(User Settings)JSON 文件(可在文本编辑器的菜单中找到)中添加以下代码,每当你以此方法储存文件时,去除行尾空格操作便会自动完成:

"trim_trailing_white_space_on_save": true

缩进

整个文件中的缩进应保持前后一致,使用 Tab、2个空格或4个空格都可以,但需保持前后一致。

一般元规则

编码

使用 UTF-8(无 BOM)。
确保你的编辑器将没有字节顺序标记的 UTF-8 用作字符编码。在 HTML 模板中设置编码并用 <meta charset="utf-8"> 记录。

注释

在可行和必要时,对代码进行注释。
用注释解释代码的覆盖范围、目的和作用以及使用和选择各解决方案的原因。

任务项

TODO: 标注待办事项和任务项:
仅用关键词 TODO 标注待办事项,不要使用 @@ 等其他格式的字样。在任务项前加冒号,如: TODO: 待办任务

推荐:

<!-- TODO: 对出下联 -->
<ul>
    <li>风吹云,云随风,风云变幻</li>
</ul>

HTML 样式规则

文件类型

使用 HTML5 。
所有 HTML 文件均应使用 HTML5 ( HTML 语法): <!DOCTYPE html>
不要结束自结束元素,即编写 <br> ,而不是 <br />

HTML 有效性

使用有效的 HTML。
使用有效的 HTML 是可测量的基准质量,可确保 HTML的合理使用并有助于了解技术要求和限制。

不推荐:

<title>页面标题</title>
<article>这是一篇文章。

推荐:

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <title>一代人</title>
    </head>
    <body>
        <article>黑夜给了我黑色的眼睛,我却用它来寻找光明。。</article>
    </body>
</html>

语义

根据目的使用 HTML 。
根据元素的预期作用使用元素。例如,针对标题使用标题元素,针对段落使用 p 元素,针对锚点使用 a 元素等。根据目的使用HTML 对提高可访问性、再利用程度和代码效率十分重要。

不推荐:

<div onclick="goToRecommendations();">All recommendations</div>

推荐:

<a href="recommendations/">All recommendations</a>

多媒体应变计划

为多媒体设置备用内容。
确保为图片、视频或通过画布呈现的动画对象等多媒体提供其他访问方式。对于图片而言,使用有意义的 Alt 文本,对于视频,使用音频转述资料和字幕(如有)。
为方便访问,需提供备用内容,若没有 alt 属性,盲人用户将难以辨别图片的内容,其他用户也可能无法理解视频或音频的内容。
针对具有会引入冗余的 alt 属性的图片和无法立即使用 CSS 的装饰性图片,使用备用内容,即 alt=""

不推荐:

![](udacity.png)

推荐:

![](udacity.png)

关注点分离

将结构、描述和行为相互分离。
将结构(标记)、描述(样式)和行为(脚本设计)严格分开,将三者间可能发生的相互作用降至最低。
也就是说,确保文件和模板仅含有 只用于结构目的 HTML 。将所有描述性事物移至样式表,将所有行为性事物移至脚本。此外,尽可能少地连接文件和模板中的样式表和脚本,以便使接触面积最小化。
将结构、描述和行为相互分离对维护十分重要。相比对样式表和脚本进行更新,更改 HTML 文件和模板的成本往往更高。

实体引用

不要使用实体引用。
若文件、编辑器和小组之间均使用同样的编码( UTF-8 ),则无需使用 — 、” 和 or ☺ 等实体引用。
只有 HTML 中含有特殊意义的字符(如 < 和 &)以及控制和“隐式”字符除外。

不推荐:

欧元的货币符号是: “&eur;”

推荐:

欧元的货币符号是: “€”

类型属性

忽略样式表和脚本的类型属性。
不要针对样式表和脚本使用类型属性。由于 HTML 意味着文本 /css 和文本 /javascript 为默认设置,在此类语境中无需设置类型属性。在老式浏览器中,也可以安全进行此项操作。

不推荐:

<link rel="stylesheet" type="text/css" href="css/style.css">

推荐:

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

不推荐:

<script src="js/app.js" type="text/javascript"></script>

推荐:

<script src="js/app.js"></script>

HTML 格式规则

一般格式

所有代码块、列表和表元素均需另起一行,所有子元素均需缩进。
每一个代码块、列表和表元素均需另起一行,与元素的样式相独立(因为 CSS 允许元素在每一个显示属性中担任不同的角色)。
此外,代码块、列表和表元素的子元素也需进行缩进(如果你遇到列表项间存在空白的问题,可以将所有 li 元素放置在一行)。

推荐:

<blockquote>
    <p>啊!<em>船长!</em>我的船长!</p>
</blockquote>
<ul>
    <li>啊.船长,我的船长!我们艰苦的航程已经终结,</li>
    <li>这只船安然渡过了一切风浪,我们寻求的奖赏已经获得。</li>
    <li>港口在望,我听见钟声在响,人们都在欢呼,</li>
    <li>目迎着我们的船从容返航,它显得威严而英武。</li>
    <li>可是,啊,心啊!心啊!心啊!</li>
    <li>啊.殷红的鲜血长流,</li>
    <li>在甲板上,那里躺着我的船长,</li>
    <li>他已倒下,已死去,已冷却。</li>
    <li>啊,船长,我的船长!起来吧,起来听听这钟声,</li>
    <li>起来,——旌旗正为你招展——军号正为你发出颤音。</li>
    <li>为你.送来了这些花束和花环。</li>
    <li>为你,熙攘的群众在呼唤,转动着多少殷切的脸。</li>
    <li>这里,船长!亲爱的父亲!</li>
    <li>你头颅下边是我的手臂!</li>
    <li>在甲板上像是在一场梦里,</li>
    <li>你已倒下,已死去,已冷却。</li>
    <li>我们的船长不作回答,他的双唇惨白而寂静,</li>
    <li>我的父亲不能感觉我的手臂,他已没有脉息、没有知觉,</li>
    <li>我们的船已安全抛锚碇泊,已经结束了它的航程,</li>
    <li>胜利的船从险恶的旅途归来,我们寻求的已赢得手中。</li>
    <li>欢呼吧,啊,海岸!轰鸣,啊,洪钟!</li>
    <li>可是,我却轻移悲伤的步履,</li>
    <li>在甲板上,那里躺着我的船长,</li>
    <li>他已倒下,已死去,已冷却。</li>
</ul>
<table>
    <thead>
        <tr>
            <th scope="col">姓名</th>
            <th scope="col">职业</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>瓦尔特·惠特曼</td>
            <td>诗人</td>
        </tr>
    </tbody>
</table>

HTML 引号

在引用属性值时,使用双引号。

不推荐:

<a href='login/' class='btn btn-secondary'>登陆</a>

推荐:

<a href="login/" class="btn btn-secondary">登陆</a>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容

  • 问答题47 /72 常见浏览器兼容性问题与解决方案? 参考答案 (1)浏览器兼容问题一:不同浏览器的标签默认的外补...
    _Yfling阅读 13,703评论 1 92
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,047评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,494评论 18 139
  • 4月,重庆绿色志愿者起诉饿了么,美团,百度外卖三大订餐平台,认为他们在提醒消费者服务上做的不足,造成医院浪费,环境...
    不是养蚕人阅读 161评论 0 0
  • 放诸古今中外皆准的权力准则名义选民 实际选民 胜利联盟 选民的大脑想要什么不怕敌人的勇敢故事 自我救赎的奋斗故事 ...
    Yuchao阅读 646评论 0 0