陌上花开

谷歌 HTML/CSS 规范

2017/9/6 22:01:26admin0 阅读13 评论
#前端笔记 #规范命名

<h2>背景</h2>

这篇文章定义了 HTML 和 CSS 的格式和代码规范，旨在提高代码质量和协作效率。
<h2>通用样式规范</h2>
<h2><span style=“color:#69d2f9;”>协议</span></h2>

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

<pre class=“line-numbers language-javascript”><code class=“language-javascript”><!-- Not recommended –>
<script src="https://www.google.com/js/gweb/analytics/autotrack.js&quot;&gt;&lt;/script&gt;</code></pre>

<pre class=“line-numbers language-javascript”><code class=“language-javascript”><!-- Recommended –>
<script src="//www.google.com/js/gweb/analytics/autotrack.js"></script></code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
.example {
background: url(https://www.google.com/images/example);
}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
.example {
background: url(//www.google.com/images/example);
}</code></pre>

<h2>通用格式规范</h2>
<h2><span style=“color:#69d2f9;”>缩进</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><ul>
<li>Fantastic
<li>Great
</ul></code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>.example {
color: blue;
}</code></pre>

<h2><span style=“color:#69d2f9;”>大小写</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
<A HREF="/">Home</A></code></pre>

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Recommended –>
<img src="google.png" alt="Google"></code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”> /* Not recommended */
color: #E5E5E5;</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
color: #e5e5e5;</code></pre>

<h2><span style=“color:#69d2f9;”>结尾空格</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
<p>What?_

&lt;!-- Recommended --&gt;
&lt;p&gt;Yes please.</code></pre>

<h2>通用元规范</h2>
<h2><span style=“color:#69d2f9;”>编码</span></h2>

在 HTML 中通过指定编码方式，CSS 中不需要指定，因为默认是 UTF-8。
<h2><span style=“color:#69d2f9;”>注释</span></h2>

使用注释来解释代码：包含的模块，功能以及优点。
<h2><span style=“color:#69d2f9;”>任务项</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><!-- TODO: remove optional tags –>
<ul>
<li>Apples</li>
<li>Oranges</li>
</ul></code></pre>

<h2>HTML 风格规范</h2>
<h2><span style=“color:#69d2f9;”>文档类型</span></h2>

HTML 文档应使用 HTML5 的文档类型：<!DOCTYPE html>。
孤立标签无需封闭自身，<br> 不要写成 <br />。
<h2><span style=“color:#69d2f9;”>HTML 正确性</span></h2>

尽可能使用正确的 HTML。

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
<title>Test</title>
<article>This is only a test.</code></pre>

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Recommended –>
<!DOCTYPE html>
<meta charset="utf-8">
<title>Test</title>
<article>This is only a test.</article></code></pre>

<h2><span style=“color:#69d2f9;”>语义化</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
<div onclick="goToRecommendations();">All recommendations</div></code></pre>

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Recommended –>
<a href="recommendations/">All recommendations</a></code></pre>

<h2><span style=“color:#69d2f9;”>多媒体元素降级</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
<img src="spreadsheet.png"></code></pre>

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Recommended –>
<img src="spreadsheet.png" alt="Spreadsheet screenshot."></code></pre>

<h2><span style=“color:#69d2f9;”>关注分离</span></h2>

标记、样式和脚本分离，确保相互耦合最小化。
<h2><span style=“color:#69d2f9;”>实体引用</span></h2>

如果团队中文件和编辑器使用同样的编码方式，就没必要使用实体引用，如 <span style=“color:#69d2f9;”><strong>—</strong></span>，<span style=“color:#69d2f9;”><strong>”<?stromg></span>，<span style=“color:#69d2f9;”><strong>☺</strong></span>，除了一些在 HTML 中有特殊含义的字符（如 < 和 &）以及不可见的字符（如空格）。

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
The currency symbol for the Euro is &ldquo;&eur;&rdquo;.</code></pre>

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Recommended –>
The currency symbol for the Euro is “€”.</code></pre>

<h2><span style=“color:#69d2f9;”>type 属性</span></h2>

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

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –>
<link rel="stylesheet" href="//www.google.com/css/maia.css"
type="text/css">

&lt;!-- Recommended --&gt;
&lt;link rel=&quot;stylesheet&quot; href=&quot;//www.google.com/css/maia.css&quot;&gt;

&lt;!-- Not recommended --&gt;&lt;script src=&quot;//www.google.com/js/gweb/analytics/autotrack.js&quot;
  type=&quot;text/javascript&quot;&gt;&lt;/script&gt;

&lt;!-- Recommended --&gt;&lt;script src=&quot;//www.google.com/js/gweb/analytics/autotrack.js&quot;&gt;&lt;/script&gt;</code></pre>

<h2>HTML 格式规范</h2>
<h2><span style=“color:#69d2f9;”>HTML 引号</span></h2>

属性值用双引号。

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Not recommended –><a class='maia-button maia-button-secondary'>Sign in</a></code></pre>

<pre class=“line-numbers language-html”><code class=“language-html”><!-- Recommended –><a class="maia-button maia-button-secondary">Sign in</a></code></pre>

<h2>CSS 风格规范</h2>
<h2><span style=“color:#69d2f9;”>ID 和 Class 命名</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended: meaningless */
#yee-1901 {}

/* Not recommended: presentational */
.button-green {}
.clear {}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended: specific */
#gallery {}
#login {}
.video {}

/* Recommended: generic */
.aux {}
.alt {}</code></pre>

<h2><span style=“color:#69d2f9;”>ID 和 Class 命名风格</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
#navigation {}
.atr {}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
#nav {}
.author {}</code></pre>

<h2><span style=“color:#69d2f9;”>选择器</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
ul#example {}
div.error {}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
#example {}
.error {}</code></pre>

<h2><span style=“color:#69d2f9;”>属性简写</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
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;</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
border-top: 0;
font: 100%/1.6 palatino, georgia, serif;
padding: 0 1em 2em;</code></pre>

<h2><span style=“color:#69d2f9;”>0 和单位</span></h2>
值为 0 时不用添加单位。

<pre class=“line-numbers language-css”><code class=“language-css”>margin: 0;
padding: 0;</code></pre>

<h2><span style=“color:#69d2f9;”>开头的 0</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>font-size: .8em;</code></pre>

16进制表示法

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
color: #eebbcc;</code></pre>

<br />
<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
color: #ebc;</code></pre>

<h2><span style=“color:#69d2f9;”>前缀</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>.adw-help {} /* AdWords /
#maia-note {} / Maia */</code></pre>

<h2><span style=“color:#69d2f9;”>ID 和 Class 命名分隔符</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended: does not separate the words “demo” and “image” */
.demoimage {}

/* Not recommended: uses underscore instead of hyphen */
.error_status {}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
#video-id {}
.ads-sample {}</code></pre>

<h2>CSS 格式规范</h2>
<h2><span style=“color:#69d2f9;”>书写顺序</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-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;</code></pre>

<h2><span style=“color:#69d2f9;”>块级内容缩进</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>@media screen, projection {

  html {
    background: #fff;
    color: #444;
  }

}</code></pre>

<h2><span style=“color:#69d2f9;”>声明结束</span></h2>

每行 CSS 都应以分号结尾。

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
.test {
display: block;
height: 100px
}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
.test {
display: block;
height: 100px;
}</code></pre>

<h2><span style=“color:#69d2f9;”>属性名结尾</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
h3 {
font-weight:bold;
}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
h3 {
font-weight: bold;
}</code></pre>

<h2><span style=“color:#69d2f9;”>声明样式块的分隔</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended: missing space */
#video{
margin-top: 1em;
}

/* Not recommended: unnecessary line break */
#video
{
  margin-top: 1em;
}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
#video {
margin-top: 1em;
}</code></pre>

<h2><span style=“color:#69d2f9;”>选择器分隔</span></h2>

每个选择器都另起一行。

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
a:focus, a:active {
position: relative; top: 1px;
}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
h1,
h2,
h3 {
font-weight: normal;
line-height: 1.2;
}</code></pre>

<h2><span style=“color:#69d2f9;”>规则分隔</span></h2>

规则之间都用空行隔开。

<pre class=“line-numbers language-css”><code class=“language-css”>html {
background: #fff;
}

body {
  margin: auto;
  width: 50%;
}</code></pre>

<h2><span style=“color:#69d2f9;”>CSS 引号</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Not recommended */
@import url(“//www.google.com/css/maia.css”);

html {
  font-family: "open sans", arial, sans-serif;
}</code></pre>

<pre class=“line-numbers language-css”><code class=“language-css”>/* Recommended */
@import url(//www.google.com/css/maia.css);

html {
  font-family: 'open sans', arial, sans-serif;
}</code></pre>

<h2>CSS 元规则</h2>
<h2><span style=“color:#69d2f9;”>分段注释</span></h2>

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

<pre class=“line-numbers language-css”><code class=“language-css”>/* Header */

#adw-header {}

/* Footer */

#adw-footer {}

/* Gallery */

.adw-gallery {}</code></pre>

<h2>结语</h2>

坚持遵循代码规范。
<br />
<blockquote>
来自：<a href=“https://segmentfault.com/a/1190000007023192” target=“_blank”>Web Develop - SegmentFault<a>

原文：<a href="https://google.github.io/styleguide/htmlcssguide.xml" target="_blank">Google HTML/CSS Style Guide</a>

</blockquote>

评论区

  • 杳无宗#5
    杳无宗2017/9/16 09:10:02

    没错没错 [haobang] ，平时再多写多练就好了

    WindowsChrome

    • xiaomo#1
      xiaomo2017/9/16 13:38:45
      @杳无宗

      受教了 [ciya]

      WindowsFirefox

  • 任心畅想#4
    任心畅想2017/9/14 21:14:26

    不错，学习了 [qiang]

    LinuxChrome

    • xiaomo#1
      xiaomo2017/9/15 23:00:19
      @任心畅想

      那就好 [xieyanxiao]

      WindowsFirefox

  • c0smxsec#3
    c0smxsec2017/9/9 15:46:29

    [xieyanxiao] 可爱的浏览器会迁就我们的

    LinuxChrome

    • xiaomo#1
      xiaomo2017/9/11 19:29:17
      @c0smxsec

      这…，说的我无言反驳了 [xiaoku]

      WindowsFirefox

  • 轩陌#2
    轩陌2017/9/8 09:10:41

    [dabing] 不错不错，这个验证码应该搞成大位数相乘 [yinxian]

    macOSChrome

    • xiaomo#4
      xiaomo2017/9/11 19:26:46
      @轩陌

      这个嘛，我不会弄 [qiudale]

      WindowsFirefox

    • 轩陌#3
      轩陌2017/9/9 20:34:33
      @xiaomo

      [touxiao] 让他们算不清楚也好，你这个没有邮件提醒都不知道你回复人家了

      macOSChrome

    • xiaomo#2
      xiaomo2017/9/8 12:09:00
      @轩陌

      位数大了，万一别人数学没学好，岂不是算不清了 [doge]

      WindowsFirefox

    • xiaomo#1
      xiaomo2017/9/8 12:07:59
      @轩陌

      [lenghan] 不要搞事情啊，我跟你说

      WindowsFirefox

  • 无人小站#1
    无人小站2017/9/7 08:13:26

    遵循W3C装逼标准2333 [huaixiao]

    WindowsChrome

    • xiaomo#1
      xiaomo2017/9/7 19:59:58
      @无人小站

      [xieyanxiao]

      WindowsFirefox