谷歌HTML/CSS规范

背景

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

通用样式规范

协议

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

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

 

通用格式规范

缩进

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

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

 

大小写

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

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

 

结尾空格

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

1 <!-- Not recommended -->
2 <p>What?_
3 <!-- Recommended -->
4 <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>。
孤立标签无需封闭自身，`
 不要写成 
。`

HTML 正确性

尽可能使用正确的 HTML。

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

 

语义化

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

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

 

多媒体元素降级

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

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

 

关注分离

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

实体引用

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

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

 

type 属性

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

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

 

HTML 格式规范

HTML 引号

属性值用双引号。

1 <!-- Not recommended -->
2 <a class='maia-button maia-button-secondary'>Sign in</a>
3 <!-- Recommended -->
4 <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 {}
 7 /* Recommended: specific */
 8 #gallery {}
 9 #login {}
10 .video {}
11 
12 /* Recommended: generic */
13 .aux {}
14 .alt {}

 



 


ID 和 Class 命名风格


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




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




 


选择器


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




1 /* Not recommended */
2 ul#example {}
3 div.error {}
4 /* Recommended */
5 #example {}
6 .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;
10 /* Recommended */
11 border-top: 0;
12 font: 100%/1.6 palatino, georgia, serif;
13 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 color: #eebbcc;
3 /* Recommended */
4 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 {}
6 /* Recommended */
7 #video-id {}
8 .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 .test {
 3   display: block;
 4   height: 100px
 5 }
 6 /* Recommended */
 7 .test {
 8   display: block;
 9   height: 100px;
10 }




 


属性名结尾


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




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




 


声明样式块的分隔


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




 1 /* Not recommended: missing space */
 2 #video{
 3   margin-top: 1em;
 4 }
 5 
 6 /* Not recommended: unnecessary line break */
 7 #video
 8 {
 9   margin-top: 1em;
10 }
11 /* Recommended */
12 #video {
13   margin-top: 1em;
14 }




 


选择器分隔


每个选择器都另起一行。




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




 


规则分隔


规则之间都用空行隔开。




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




 


CSS 引号


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




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




 


CSS 元规则


分段注释


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




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




 


结语


坚持遵循代码规范。


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


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


转载自：http://www.codeceo.com




 






            

            
posted @ 
2017-08-31 15:33 
栗子_维C 
阅读(195) 
评论(0) 
编辑 
收藏 
举报