[译]谷歌 HTML/CSS 规范

开发 前端
这篇文章定义了 HTML 和 CSS 的格式和代码规范,旨在提高代码质量和协作效率。

[[172592]]

背景

这篇文章定义了 HTML 和 CSS 的格式和代码规范,旨在提高代码质量和协作效率。

通用样式规范

协议

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

  1. <!-- Not recommended --> 
  2.  
  3. <script src="https://www.google.com/js/gweb/analytics/autotrack.js"></script>  
  1. <!-- Recommended --> 
  2.  
  3. <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>  
  1. /* Not recommended */ 
  2.  
  3. .example { 
  4.  
  5. background: url(https://www.google.com/images/example); 
  6.  
  7.  
  1. /* Recommended */ 
  2.  
  3. .example { 
  4.  
  5. background: url(//www.google.com/images/example); 
  6.  
  7.  

通用格式规范

缩进

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

  1. <ul> 
  2.   <li>Fantastic 
  3.   <li>Great 
  4. </ul>  
  1. .example { 
  2.  
  3.     color: blue; 
  4.  
  5.  

大小写

以下都应该用小写:HTML 元素名称,属性,属性值(除非 text/CDATA),CSS 选择器,属性,属性值。 

  1. <!-- Not recommended --> 
  2. <A HREF="/">Home</A>  
  1. <!-- Recommended --> 
  2.  
  3. <img src="google.png" alt="Google" 
  1. /* Not recommended */ 
  2.  
  3. color: #E5E5E5;  
  1. /* Recommended */ 
  2.  
  3. color: #e5e5e5;  

结尾空格

结尾空格不仅多余,而且在比较代码时会更麻烦。 

  1. <!-- Not recommended --> 
  2.  
  3. <p>What?_  
  1. <!-- Recommended --> 
  2.  
  3. <p>Yes please.  

通用元规范

编码

在 HTML 中通过 <meta charset="utf-8"> 指定编码方式,CSS 中不需要指定,因为默认是 UTF-8。

注释

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

任务项

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

  1. <!-- TODO: remove optional tags --> 
  2. <ul> 
  3.   <li>Apples</li> 
  4.   <li>Oranges</li> 
  5. </ul>  

HTML 风格规范

文档类型

HTML 文档应使用 HTML5 的文档类型:<!DOCTYPE html>。

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

HTML 正确性

尽可能使用正确的 HTML。 

  1. <!-- Not recommended --> 
  2. <title>Test</title> 
  3. <article>This is only a test.  
  1. <!-- Recommended --> 
  2. <!DOCTYPE html> 
  3. <meta charset="utf-8"
  4. <title>Test</title> 
  5. <article>This is only a test.</article>  

语义化

根据使用场景选择正确的 HTML 元素(有时被错误的称为“标签”)。例如,使用 h1 元素创建标题,p 元素创建段落,a 元素创建链接等等。正确的使用 HTML 元素对于可访问性、可重用性以及编码效率都很重要。

  1. <!-- Not recommended --> 
  2. <div onclick="goToRecommendations();">All recommendations</div>  
  1. <!-- Recommended --> 
  2.  
  3. <a href="recommendations/">All recommendations</a>  

多媒体元素降级

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

  1. <!-- Not recommended --> 
  2.  
  3. <img src="spreadsheet.png" 
  1. <!-- Recommended --> 
  2.  
  3. <img src="spreadsheet.png" alt="Spreadsheet screenshot." 

关注分离

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

实体引用

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

  1. <!-- Not recommended --> 
  2.  
  3. The currency symbol for the Euro is “&eur;”.  
  1. <!-- Recommended --> 
  2.  
  3. The currency symbol for the Euro is “€”.  

type 属性

在引用样式表和脚本时,不要指定 type 属性,除非不是 CSS 或 JavaScript。因为 HTML5 中已经默认指定样式变的 type 是 text/css,脚本的type 是 text/javascript。 

  1. <!-- Not recommended --> 
  2.  
  3. <link rel="stylesheet" href="//www.google.com/css/maia.css" 
  4.  
  5. type="text/css" 
  1. <!-- Recommended --> 
  2. <link rel="stylesheet" href="//www.google.com/css/maia.css" 
  1. <!-- Not recommended --> 
  2.  
  3. <script src="//www.google.com/js/gweb/analytics/autotrack.js" 
  4.  
  5. type="text/javascript"></script>  
  1. <!-- Recommended --> 
  2.  
  3. <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>  

HTML 格式规范

HTML 引号

属性值用双引号。 

  1. <!-- Not recommended --> 
  2.  
  3. <a class='maia-button maia-button-secondary'>Sign in</a>  
  1. <!-- Recommended --> 
  2.  
  3. <a class="maia-button maia-button-secondary">Sign in</a>  

CSS 风格规范

ID 和 Class 命名

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

  1. /* Not recommended: meaningless */ 
  2. #yee-1901 {} 
  3.  
  4. /* Not recommended: presentational */ 
  5. .button-green {} 
  6. .clear {}  
  1. /* Recommended: specific */ 
  2. #gallery {} 
  3. #login {} 
  4. .video {} 
  5.  
  6. /* Recommended: generic */ 
  7. .aux {} 
  8. .alt {}  

ID 和 Class 命名风格

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

  1. /* Not recommended */ 
  2. #navigation {} 
  3. .atr {}  
  1. /* Recommended */ 
  2.  
  3. #nav {} 
  4.  
  5. .author {}  

选择器

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

  1. /* Not recommended */ 
  2. ul#example {} 
  3. div.error {}  
  1. /* Recommended */ 
  2.  
  3. #example {} 
  4.  
  5. .error {}  

属性简写

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

  1. /* Not recommended */ 
  2. border-top-style: none; 
  3. font-family: palatino, georgia, serif; 
  4. font-size: 100%; 
  5. line-height: 1.6; 
  6. padding-bottom: 2em; 
  7. padding-left: 1em; 
  8. padding-right: 1em; 
  9. padding-top: 0;  
  1. /* Recommended */ 
  2. border-top: 0; 
  3. font: 100%/1.6 palatino, georgia, serif; 
  4. padding: 0 1em 2em;  

0 和单位

值为 0 时不用添加单位。 

  1. margin: 0; 
  2. padding: 0;  

开头的 0

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

  1. font-size: .8em; 

16进制表示法 

  1. /* Not recommended */ 
  2.  
  3. color: #eebbcc; 
  1. /* Recommended */  
  2.   
  3. color: #ebc;  

前缀

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

  1. .adw-help {} /* AdWords */ 
  2. #maia-note {} /* Maia */  

ID 和 Class 命名分隔符

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

  1. /* Not recommended: does not separate the words “demo” and “image” */ 
  2. .demoimage {} 
  3.  
  4. /* Not recommended: uses underscore instead of hyphen */ 
  5. .error_status {}  
  1. /* Recommended */ 
  2.  
  3. #video-id {} 
  4.  
  5. .ads-sample {}  

CSS 格式规范

书写顺序

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

  1. background: fuchsia; 
  2. border: 1px solid; 
  3. -moz-border-radius: 4px; 
  4. -webkit-border-radius: 4px; 
  5. border-radius: 4px; 
  6. color: black; 
  7. text-align: center; 
  8. text-indent: 2em;  

块级内容缩进

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

  1. @media screen, projection { 
  2.  
  3.   html { 
  4.     background: #fff; 
  5.     color: #444; 
  6.   } 
  7.  
  8.  

声明结束

每行 CSS 都应以分号结尾。

  1. /* Not recommended */ 
  2.  
  3. .test { 
  4.  
  5. display: block; 
  6.  
  7. height: 100px 
  8.  
  9.  
  1. /* Recommended */ 
  2.  
  3. .test { 
  4.  
  5. display: block; 
  6.  
  7. height: 100px; 
  8.  

 属性名结尾

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

  1. /* Not recommended */ 
  2.  
  3. h3 { 
  4.  
  5. font-weight:bold; 
  6.  
  7.  
  1. /* Recommended */ 
  2.  
  3. h3 { 
  4.  
  5. font-weight: bold; 
  6.  
  7.  

声明样式块的分隔

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

  1. /* Not recommended: missing space */ 
  2. #video{ 
  3.   margin-top: 1em; 
  4.  
  5. /* Not recommended: unnecessary line break */ 
  6. #video 
  7.   margin-top: 1em; 
  8.  
  1. /* Recommended */ 
  2.  
  3. #video { 
  4.  
  5. margin-top: 1em; 
  6.  
  7.  

选择器分隔

每个选择器都另起一行。 

  1. /* Not recommended */ 
  2.  
  3. a:focus, a:active { 
  4.  
  5. position: relativetop: 1px; 
  6.  
  7.  
  1. /* Recommended */ 
  2.  
  3. h1, 
  4.  
  5. h2, 
  6.  
  7. h3 { 
  8.  
  9. font-weight: normal; 
  10.  
  11. line-height: 1.2; 
  12.  
  13.  

规则分隔

规则之间都用空行隔开。

  1. html { 
  2.   background: #fff; 
  3.  
  4. body { 
  5.   margin: auto; 
  6.   width: 50%; 
  7.  

CSS 引号

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

  1. /* Not recommended */ 
  2.  
  3. @import url("//www.google.com/css/maia.css"); 
  4.  
  5. html { 
  6.  
  7. font-family: "open sans", arial, sans-serif; 
  8.  
  9.  
  1. /* Recommended */ 
  2.  
  3. @import url(//www.google.com/css/maia.css); 
  4.  
  5. html { 
  6.  
  7. font-family: 'open sans', arial, sans-serif; 
  8.  
  9.  

CSS 元规则

分段注释

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

  1. /* Header */ 
  2.  
  3. #adw-header {} 
  4.  
  5. /* Footer */ 
  6.  
  7. #adw-footer {} 
  8.  
  9. /* Gallery */ 
  10.  
  11. .adw-gallery {}  

结语

坚持遵循代码规范。

写代码前先看看周围同事的代码,然后决定代码风格。

代码规范的意义在于提供一个参照物。这里提供了一份全局的规范,但是你也得参照公司内部的规范,否则阅读你代码的人会很痛苦。

责任编辑:庞桂玉 来源: segmentfault
相关推荐

2020-04-16 21:02:35

前端命名规范html规范

2015-03-18 09:34:47

程序员编码规范

2017-07-20 11:11:39

前端CSS书写规范

2010-08-31 13:32:12

CSS

2022-12-28 08:16:30

CSS新规范样式

2010-08-31 11:25:15

2010-09-01 09:59:32

CSS

2009-06-23 09:25:01

谷歌人才流失

2010-08-24 15:31:51

DIVCSS

2010-09-02 09:32:09

DIV CSS

2010-09-01 10:17:38

CSShack注释

2014-03-17 09:34:01

HTMLHTML闭合

2010-08-16 14:07:44

盒模型marginpadding

2010-08-27 15:16:26

htmlbodyCSS

2014-08-07 10:13:43

谷歌Material De设计规范

2014-08-28 11:12:14

谷歌

2013-09-16 10:19:08

htmlcssJavaScript

2010-09-13 09:35:28

DIVCSS

2014-06-17 12:50:04

2010-09-07 15:53:02

CSS规范化
点赞
收藏

51CTO技术栈公众号