前端规范 (持续迭代更新)

**不支持HTML标签 差评~ ** 这里支持

前端规范 by@xxShen


初衷:编写灵活、稳定、高质量的 HTML 和 CSS 代码的规范。

目标:不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。

定律:遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的。这个规范里存在争议和错误,欢迎讨论和指正。

目录

HTML

CSS

其他

<span id="htmlType01">语法</span>

  • 用4个空格来代替tab(制表符) -- 这是唯一能保证在所有环境下获得一致展现的方法。绝大部分的编辑器都可修改tab为4个空格

  • 嵌套元素应该锁进1次

  • 属性的定义,确保全部使用双引号,绝不要使用单引号

  • 不要在自闭合(self-closing)元素的尾部添加斜线。(搜HTML5规范,明确的说)

  • 不要省略可选的结束标签(closing tag)(举个栗子,</span> 或 </body>)。

<!DOCTYPE html>
<html>
    <head>
        <title>Page title</title>
    </head>
    <body>
        <img src="images/company-logo.png" alt="Company">
        <h1 class="hello-world">Hello, world!</h1>
    </body>
</html>

<span id="htmlType02">HTML基础设施</span>

  • 文件应以“<!DOCTYPE ......>”首行顶格开始,推荐使用“<!DOCTYPE html>”

  • 必须申明文档的编码charset,且与文件本身编码保持一致,使用UTF-8编码<meta charset="utf-8"/>

  • 根据页面内容和需求填写适当的keywords和description(按需求来,不做强求)

  • 结构、表现、行为三者分离,避免内联

  • 使用link将css文件引入,并置于head中。

  • 使用script将js文件引入,并置于body底部

  • 强烈建议为 html 根元素指定 <span style="color:#f60;">lang</span> 属性

  • 根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 <span style="color:#f60;">type</span> 属性,因为 <span style="color:#f60;">text/css</span> 和 <span style="color:#f60;">text/javascript</span> 分别是它们的默认值

  • 遵循 HTML 标准和语义,但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度

<!DOCTYPE html>
<html lang="zh-CN">
    <head>
        <meta charset="utf-8" />
        <title>才客:好玩的人才众筹网站</title>
        <meta name="keywords" content="" />
        <meta name="description" content="" />
        <meta name="viewport" content="width=device-width" />
        <link rel="stylesheet" href="css/style.css" />
        <link rel="shortcut icon" href="img/favicon.ico" />
        <link rel="apple-touch-icon" href="img/touchicon.png" />
    </head>
    <body>
        ……
        <script src="js/dome.js"></script>  
    </body>
</html>

<span id="htmlType03">布尔(boolean)型属性</span>

  • 布尔型属性可以在声明时不赋值。XHTML 规范要求为其赋值,但是 HTML5 规范不需要。
    元素的布尔型属性如果有值,就是 true,如果没有值,就是 false。如果一定要为其赋值的话,请参考 WhatWG 规范:
    如果属性存在,其值必须是空字符串或 [...] 属性的规范名称,并且不要再收尾添加空白符。
    简单来说,就是不用赋值

<span id="htmlType04">减少标签的数量</span>

  • 编写 HTML 代码时,尽量避免多余的父元素。很多时候,这需要迭代和重构来实现。请看下面的案例:
<span class="avatar"><!--not good-->
  <img src="...">
</span>

<img class="avatar" src="..."><!--better-->

<span id="htmlType05">JavaScript 生成的标签</span>

  • 通过 JavaScript 生成的标签让内容变得不易查找、编辑,并且降低性能。能避免时尽量避免。

<span id="cssType01">CSS语法</span>

  • 用4个空格来代替制表符(tab)

  • 为选择器分组时,将单独的选择器单独放在一行。

  • 为了代码的易读性,在每个声明块的左花括号前添加一个空格。

  • 声明块的右花括号应当单独成行。

  • 每条声明语句的 : 后应该插入一个空格。

  • 为了获得更准确的错误报告,每条声明都应该独占一行。

  • 所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但是,如果省略这个分号,你的代码可能更易出错。

  • 对于以逗号分隔的属性值,每个逗号后面都应该插入一个空格(例如,<span style="color:#f60;">box-shadow</span>)。

  • 不要在 <span style="color:#f60;">rgb()</span>、<span style="color:#f60;">rgba()</span>、<span style="color:#f60;">hsl()</span>、<span style="color:#f60;">hsla()</span> 或 <span style="color:#f60;">rect()</span> 值的内部的逗号后面插入空格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号,不加空格)。

  • 对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,<span style="color:#f60;">.5</span> 代替 <span style="color:#f60;">0.5</span>;<span style="color:#f60;">-.5px</span> 代替 <span style="color:#f60;">-0.5px</span>)。

  • 十六进制值应该全部小写,例如,#fff。在扫描文档时,小写字符易于分辨,因为他们的形式更易于区分。

  • 尽量使用简写形式的十六进制值,例如,用 <span style="color:#f60;">#fff</span> 代替 <span style="color:#f60;">#ffffff</span>。

  • 为选择器中的属性添加双引号,例如,<span style="color:#f60;">input[type="text"]</span>。只有在某些情况下是可选的,但是,为了代码的一致性,建议都加上双引号。

  • 避免为 0 值指定单位,例如,用 <span style="color:#f60;">margin: 0</span>; 代替 <span style="color:#f60;">margin: 0px</span>;。

/* Bad CSS */
.selector, .selector-secondary, .selector[type=text] {
  padding:15px;
  margin:0px 0px 15px;
  background-color:rgba(0, 0, 0, 0.5);
  box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF
}

/* Good CSS */
.selector,
.selector-secondary,
.selector[type="text"] {
  padding: 15px;
  margin-bottom: 15px;
  background-color: rgba(0,0,0,.5);
  box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff;
}

<span id="cssType02">不要使用 <em style="color:#f60;">@import</em></span>

  • 与 <link> 标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。替代办法有以下几种:

    • 使用多个 <link> 元素

    • 通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件

    • 通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能

<span id="cssType03">简写形式的属性声明 </span>

在需要显示地设置所有值的情况下,应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下:

  • <span style="color:#f60;">padding</span>
  • <span style="color:#f60;">margin</span>
  • <span style="color:#f60;">font</span>
  • <span style="color:#f60;">background</span>
  • <span style="color:#f60;">border</span>
  • <span style="color:#f60;">border-radius</span>

不需要为简写形式的属性声明指定所有值。例如,HTML 的 heading 元素只需要设置上、下边距(margin)的值,因此,在必要的时候,只需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱,并且会对属性值带来不必要的覆盖从而引起意外的副作用。

/* Bad example */
.element {
  margin: 0 0 10px;
  background: red;
  background: url("image.jpg");
  border-radius: 3px 3px 0 0;
}

/* Good example */
.element {
  margin-bottom: 10px;
  background-color: red;
  background-image: url("image.jpg");
  border-top-left-radius: 3px;
  border-top-right-radius: 3px;
}

<span id="cssType04">注释</span>

代码是由人编写并维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或 class 名称。

对于较长的注释,务必书写完整的句子;对于一般性注解,可以书写简洁的短语。

/* Bad example */
/* Modal header */
.modal-header {
  ...
}

/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  ...
}

<span id="cssType05">class 命名</span>

  • class 名称中只能出现小写字符驼峰法(不是下划线,也不是破折号)。破折号应当用于相关 class 的命名(类似于命名空间)(例如,.btn 和 .btn-danger)。
  • 避免过度任意的简写。.btn 代表 button,但是 .s 不能表达任何意思。
  • class 名称应当尽可能短,并且意义明确。
  • 使用有意义的名称。使用有组织的或目的明确的名称,不要使用表现形式(presentational)的名称。
  • 基于最近的父 class 或基本(base) class 作为新 class 的前缀。
  • 使用 .js-* class 来标识行为(与样式相对),并且不要将这些 class 包含到 CSS 文件中。

在为 Sass 和 Less 变量命名是也可以参考上面列出的各项规范。

/* Bad example */
.t { ... }
.red { ... }
.header { ... }

/* Good example */
.tweet { ... }
.important { ... }
.tweetHeader { ... }

<span id="cssType06">选择器</span>

  • 对于通用元素使用 class ,这样利于渲染性能的优化。
  • 对于经常出现的组件,避免使用属性选择器(例如,[class^="..."])。浏览器的性能会受到这些因素的影响。
  • 选择器要尽可能短,并且尽量限制组成选择器的元素个数,建议不要超过 3 。
  • 只有在必要的时候才将 class 限制在最近的父元素内(也就是后代选择器)(例如,不使用带前缀的 class 时 -- 前缀类似于命名空间)。
/* Bad example */
span { ... }
.page-container #stream .stream-item .tweet .tweet-header .username { ... }
.avatar { ... }

/* Good example */
.avatar { ... }
.tweet-header .username { ... }
.tweet .avatar { ... }

<span id="otherType01">编辑器配置</span>

将你的编辑器按照下面的配置进行设置,以避免常见的代码不一致和差异:

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 什么是html? html是一种网页标记语言,叫超文本标记语言,我们平时上网所看到的所有网页均来自于html,英文...
    波段顶底阅读 8,340评论 2 7
  • CSS基础 本文包括CSS基础知识选择器(重要!!!)继承、特殊性、层叠、重要性CSS格式化排版单位和值盒模型浮动...
    廖少少阅读 3,057评论 0 40
  • 像谢娜在舞台上一样快乐。 曾几何时,我也笑的那么快乐,那种快乐是在眼睛里都可以看出来的。 现在的眼里,除了悲伤忧愁...
    起伏的身影还是很入戏阅读 432评论 0 2
  • 梦想是成人世界的奢侈品,于是,我只敢和我的儿子们一起畅谈梦想。 问四岁儿子梦想是什么?他很认真地想了想说:“妈妈,...
    素素淡阅读 200评论 0 1