Google HTML/CSS 规范

本文介绍了 Google 推荐的 HTML 和 CSS 编写格式规范，以建立良好的个人编码习惯。

1、通用样式规范

省略图片、样式、脚本以及其他媒体文件 URL 的协议部分（http:,https:），除非文件在两种协议下都不可用。这种方案称为 protocol-relative URL，好处是无论你是使用 HTTPS 还是 HTTP 访问页面，浏览器都会以相同的协议请求页面中的资源，同时可以节省一部分字节。

<!-- 不推荐 -->

<script src="https://www.google.com/js/gweb/analytics/autotrack.js"></script>

<!-- 推荐 -->

<script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>

/* 不推荐 */

.example {

  background: url("https://www.google.com/images/example");

}

/* 推荐 */

.example {

  background: url("//www.google.com/images/example");

}

1.1 缩进

一次缩进2个空格，不要使用 tab 或者混合 tab 和空格的缩进。

<ul>

  <li>Fantastic

  <li>Great

</ul>

.example {

  color: blue;

}

1.2 大小写

以下都应该用小写：HTML 元素名称，属性，属性值（除非 text/CDATA），CSS 选择器，属性，属性值。

<!-- 不推荐 -->

<A HREF="/">Home</A>

<!-- 推荐 -->

<img src="google.png" alt="Google">

/* 不推荐 */

color: #E5E5E5;

/* 推荐 */

color: #e5e5e5;

结尾空格

<!-- 不推荐 -->

<p>What?_

<!-- 推荐 -->

<p>Yes please.

1.3 编码

在 HTML 中通过 指定编码方式，CSS 中不需要指定，因为默认是 UTF-8。

注释

使用注释来解释代码：包含的模块，功能以及优点。

任务项

用 TODO 来标记待办事项，而不是用一些其他的标记，像 @@。

<!-- TODO: remove optional tags -->

<ul>

  <li>Apples</li>

  <li>Oranges</li>

</ul>

2、HTML 风格规范

2.1 文档类型

HTML 文档应使用 HTML5 的文档类型：。

孤立标签无需封闭自身，<br> 不要写成 <br />。

HTML 正确性 尽可能使用正确的 HTML。

<!-- 不推荐 -->

<title>Test</title>

<article>This is only a test.

<!-- 推荐 -->

<!DOCTYPE html>

<meta charset="utf-8">

<title>Test</title>

<article>This is only a test.</article>

语义化

<!-- 不推荐 -->

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

<!-- 推荐 -->

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

2.2 多媒体元素降级

对于像图片、视频、canvas 动画等多媒体元素，确保提供其他可访问的内容。图片可以使用替代文本（alt），视频和音频可以使用文字版本。

<!-- 不推荐 -->

<img src="spreadsheet.png">

<!-- 推荐 -->

<img src="spreadsheet.png" alt="Spreadsheet screenshot.">

2.3 关注分离

标记、样式和脚本分离，确保相互耦合最小化。

2.4 实体引用

如果团队中文件和编辑器使用同样的编码方式，就没必要使用实体引用，如 —， ”，☺，除了一些在 HTML 中有特殊含义的字符（如 < 和 &）以及不可见的字符（如空格）。

<!-- 不推荐 -->

The currency symbol for the Euro is &ldquo;&eur;&rdquo;.

<!-- 推荐 -->

The currency symbol for the Euro is “€”.

2.5 type 属性

在引用样式表和脚本时，不要指定 type 属性，除非不是 CSS 或 JavaScript。

因为 HTML5 中已经默认指定样式变的 type 是 text/css，脚本的type 是 text/javascript。

<!-- 不推荐 -->

<link rel="stylesheet" href="//www.google.com/css/maia.css"

  type="text/css">

<!-- 推荐 -->

<link rel="stylesheet" href="//www.google.com/css/maia.css">

<!-- 不推荐 -->

<script src="//www.google.com/js/gweb/analytics/autotrack.js"

  type="text/javascript"></script>

<!-- 推荐 -->

<script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>

3、HTML 格式规范

HTML 引号 属性值用双引号。

<!-- 不推荐 -->

<a class='maia-button maia-button-secondary'>Sign in</a>

<!-- 推荐 -->

<a class="maia-button maia-button-secondary">Sign in</a>

4、CSS 风格规范

4.1 ID 和 Class 命名

使用有含义的 id 和 class 名称。

/* 不推荐: 含义不明确 */

#yee-1901 {}

/* 不推荐: 按直觉来的 */

.button-green {}

.clear {}

/* 推荐: 指定含义 */

#gallery {}

#login {}

.video {}

/* 推荐: 通用 */

.aux {}

.alt {}

4.2 ID 和 Class 命名风格

id 和 class 应该尽量简短，同时要容易理解。

/* 不推荐 */

#navigation {}

.atr {}

/* 推荐 */

#nav {}

.author {}

选择器

除非需要，否则不要在 id 或 class 前加元素名。

/* 不推荐 */

ul#example {}

div.error {}

/* 推荐 */

#example {}

.error {}

4.3 属性简写

尽量使用 CSS 中可以简写的属性 (如 font)，可以提高编码效率以及代码可读性。

/* 不推荐 */

border-top-style: none;

font-family: palatino, georgia, serif;

font-size: 100%;

line-height: 1.6;

padding-bottom: 2em;

padding-left: 1em;

padding-right: 1em;

padding-top: 0;

/* 推荐 */

border-top: 0;

font: 100%/1.6 palatino, georgia, serif;

padding: 0 1em 2em;

4.4 0和单位

值为 0 时不用添加单位。

margin: 0;

padding: 0;

开头的 0

值在 -1 和 1 之间时，不需要加 0。

font-size: .8em;

4.5 16进制表示法

/* 不推荐 */

color: #eebbcc;

/* 推荐 */

color: #ebc;

4.6 前缀

使用带前缀的命名空间可以防止命名冲突，同时提高代码可维护性。

.adw-help {} /* AdWords */

#maia-note {} /* Maia */

4.7 ID 和 Class 命名分隔符

选择器中使用连字符可以提高可读性。

/* 不推荐:  “demo” 和 “image” 之间没有分隔符 */

.demoimage {}

/* 不推荐: 使用下划线 */

.error_status {}

/* 推荐 */

#video-id {}

.ads-sample {}

5、CSS 格式规范

5.1 书写顺序

按照属性首字母顺序书写 CSS 易于阅读和维护，排序时忽略带有浏览器前缀的属性。

background: fuchsia;

border: 1px solid;

-moz-border-radius: 4px;

-webkit-border-radius: 4px;

border-radius: 4px;

color: black;

text-align: center;

text-indent: 2em;

5.2 块级内容缩进

为了反映层级关系和提高可读性，块级内容都应缩进。

@media screen, projection {

  html {

    background: #fff;

    color: #444;

  }

}

5.3 声明结束

每行 CSS 都应以分号结尾。

/* 不推荐 */

.test {

  display: block;

  height: 100px

}

/* 推荐 */

.test {

  display: block;

  height: 100px;

}

5.3 属性名结尾

属性名和值之间都应有一个空格。

/* 不推荐 */

h3 {

  font-weight:bold;

}

/* 推荐 */

h3 {

  font-weight: bold;

}

5.4 声明样式块的分隔

在选择器和 {} 之间用空格隔开。

/* Not recommended: missing space */

#video{

  margin-top: 1em;

}

/* Not recommended: unnecessary line break */

#video

{

  margin-top: 1em;

}

/* 推荐 */

#video {

  margin-top: 1em;

}

5.5 选择器分隔

每个选择器都另起一行。

/* 不推荐 */

a:focus, a:active {

  position: relative; top: 1px;

}

/* 推荐 */

h1,

h2,

h3 {

  font-weight: normal;

  line-height: 1.2;

}

5.6 规则分隔

规则之间都用空行隔开。

html {

  background: #fff;

}

body {

  margin: auto;

  width: 50%;

}

5.6 CSS 引号

属性选择器和属性值用单引号，URI 的值不需要引号。

/* 不推荐 */

@import url("//www.google.com/css/maia.css");

html {

  font-family: "open sans", arial, sans-serif;

}

/* 推荐 */

@import url(//www.google.com/css/maia.css);

html {

  font-family: 'open sans', arial, sans-serif;

}

5.7 CSS 元规则

分段注释：用注释把 CSS 分成各个部分。

/* Header */

#adw-header {}

/* Footer */

#adw-footer {}

/* Gallery */

.adw-gallery {}

Google HTML/CSS 编码规范的更多相关文章

  1. css编码规范

    css编码规范 https://segmentfault.com/a/1190000002460968 常用样式测试工具 W3C CSS validator:http://jigsaw.w3.org/ ...

  2. HTML编码规范、CSS编码规范

    HTML编码规范 IE 兼容模式 IE 支持通过特定的 标签来确定绘制当前页面所应该采用的 IE 版本.除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所支持的最新的 ...

  3. Bootstrap-Other：CSS编码规范

    ylbtech-Bootstrap-Other:CSS编码规范 1.返回顶部 1. Bootstrap CSS编码规范 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致 ...

  4. 8.Bootstrap CSS编码规范

    Bootstrap CSS编码规范 本节的介绍内容为 Bootstrap 中的 CSS 编码规范. 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 为选择 ...

  5. 总结-css编码规范

    一.注释 统一采用 :/* 注释内容 */ 二.命名 1.常用命名(多查单词) 参考命名规范.doc 2.选择器 1> [建议] 选择器的嵌套层级应不大于 3 级,位置靠后的限定条件应尽可能精确 ...

  6. CSS 编码规范

    转自: https://segmentfault.com/a/1190000005046830 CSS书写格式 1.格式化代码 1.1文件 [建议]:CSS文件使用无BOM的UTF-8编码 1.2缩进 ...

  7. 前端HTML与CSS编码规范

    HTML 语法 HTML5 doctype 语言属性(Language attribute) 字符编码 IE 兼容模式 引入 CSS 和 JavaScript 文件 实用为王 属性顺序 布尔(bool ...

  8. HTML CSS 编码规范

    返璞归真,代码规范也是一门艺术 黄金定律 永远遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的.如果你发现本规范中有任何错误,敬请指正.通过open an issue on GitHu ...

  9. Google 的 Java 编码规范，参考学习！

    这份文档是 Google Java 编程风格规范的完整定义.当且仅当一个 Java 源文件符合此文档中的规则, 我们才认为它符合 Google 的 Java 编程风格. 与其它的编程风格指南一样,这里 ...

随机推荐

  1. 从零开始HTML

      1.属性 HTML 标签可以拥有属性.属性提供了有关 HTML 元素的更多的信息.属性总是以名称/值对的形式出现,比如:name="value". 属性总是在 HTML 元素的 ...

  2. JS中Exception处理

    程序开发中,编程人员经常要面对的是如何编写代码来响应错误事件的发生,即例外处理(exception handlers).如果例外处理代码设计得周全,那么最终呈现给用户的就将是一个友好的界面.否则,就会 ...

  3. github上forck一个分支之后，如何和主分支同步

    github forck一个分之后,如果过一段时间就会和主分支的差异比较大. 这样提交pr的时候 就会冲突,这个时候我们就需要和主分支同步代码 git remote add upstream git@ ...

  4. 命名空间“Microsoft.AspNet”中不存在类型或命名空间名“Mvc”

    问题: 错误 CS0234 命名空间"Microsoft.AspNet"中不存在类型或命名空间名"Mvc"(是否缺少程序集引用?) 解决方案: 打开文件夹 Us ...

  5. Mysql和Oracle的一些语法区别

    作为一个有追求的程序猿,当然要不断的学习,巴拉巴拉巴拉...好了,贴一个网址给大家,哈哈 MySQL与Oracle 差异比较:http://www.cnblogs.com/HondaHsu/p/364 ...

  6. iOS 参考 网络书籍

    网络图书: Xcode中的Project和Target: http://book.51cto.com/art/201307/402283.htm

  7. QGis（三）查询矢量图层的要素属性字段值（转载）

    QGis(三)查询矢量图层的要素属性字段值 https://github.com/gwaldron/osgearth/issues/489 当加载一个矢量图层后,如果要查看要素的属性字段值,则需要实现 ...

  8. 为什么32位操作系统最大支持4GB内存

    因为32位操作系统的地址空间为32位,地址总数为2^32,每个地址对应1Byte内存空间,这样,32位操作系统管理的最大内存空间限制为2^32Byte=4*1024*1024*1024Byte,即4G ...

  9. DELPHI中多线程知识【转】

    本文的内容取自网络,并重新加以整理,在此留存仅仅是方便自己学习和查阅.所有代码均亲自测试 delphi7下测试有效.图片均为自己制作. 多线程应该是编程工作者的基础技能, 但这个基础我从来没学过,所以 ...

  10. 利用PHPCMS V9站群功能建立分站

    hosts文件就在C:\Windows\system32\drivers\etc\hosts下 用一套CMS软件系统,做多个网站,统一管理,用户可以互通,这就是所谓的站群功能.这对于运营和维护都能节省 ...