谷歌 HTML/CSS 规范
iwyw5684
8年前
<h2><strong>背景</strong></h2> <p>这篇文章定义了 HTML 和 CSS 的格式和代码规范，旨在提高代码质量和协作效率。</p> <h2><strong>通用样式规范</strong></h2> <h3><strong>协议</strong></h3> <p>省略图片、样式、脚本以及其他媒体文件 URL 的协议部分（ <a href="/misc/goto?guid=4959717556136598546" rel="nofollow,noindex">http:,https:</a> ），除非文件在两种协议下都不可用。这种方案称为 protocol-relative URL，好处是无论你是使用 HTTPS 还是 HTTP 访问页面，浏览器都会以相同的协议请求页面中的资源，同时可以节省一部分字节。</p> <pre> <code class="language-css"><!-- Not recommended --> <script src="https://www.google.com/js/gweb/analytics/autotrack.js"></script></code></pre> <pre> <code class="language-css"><!-- Recommended --> <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script></code></pre> <pre> <code class="language-css">/* Not recommended */ .example { background: url(https://www.google.com/images/example); }</code></pre> <pre> <code class="language-css">/* Recommended */ .example { background: url(//www.google.com/images/example); }</code></pre> <h2><strong>通用格式规范</strong></h2> <h3><strong>缩进</strong></h3> <p>一次缩进2个空格，不要使用 tab 或者混合 tab 和空格的缩进。</p> <pre> <code class="language-css"><ul> <li>Fantastic <li>Great </ul></code></pre> <pre> <code class="language-css">.example { color: blue; }</code></pre> <h3><strong>大小写</strong></h3> <p>以下都应该用小写：</p> <p>HTML 元素名称，属性，属性值（除非 text/CDATA），CSS 选择器，属性，属性值。</p> <pre> <code class="language-css"><!-- Not recommended --> <A HREF="/">Home</A></code></pre> <pre> <code class="language-css"><!-- Recommended --> <img src="google.png" alt="Google"></code></pre> <pre> <code class="language-css">/* Not recommended */ color: #E5E5E5;</code></pre> <pre> <code class="language-css">/* Recommended */ color: #e5e5e5;</code></pre> <h3><strong>结尾空格</strong></h3> <p>结尾空格不仅多余，而且在比较代码时会更麻烦。</p> <pre> <code class="language-css"><!-- Not recommended --> <p>What?_</code></pre> <pre> <code class="language-css"><!-- Recommended --> <p>Yes please.</code></pre> <h2><strong>通用元规范</strong></h2> <h3><strong>编码</strong></h3> <p>在 HTML 中通过 <meta charset="utf-8"> 指定编码方式，CSS 中不需要指定，因为默认是 UTF-8。</p> <h3><strong>注释</strong></h3> <p>使用注释来解释代码：包含的模块，功能以及优点。</p> <h3><strong>任务项</strong></h3> <p>用 TODO 来标记待办事项，而不是用一些其他的标记，像 @@。</p> <pre> <code class="language-css"><!-- TODO: remove optional tags --> <ul> <li>Apples</li> <li>Oranges</li> </ul></code></pre> <h2><strong>HTML 风格规范</strong></h2> <h3><strong>文档类型</strong></h3> <p>HTML 文档应使用 HTML5 的文档类型：<!DOCTYPE html>。</p> <p>孤立标签无需封闭自身， <br> 不要写成 <br />。</p> <h3><strong>HTML 正确性</strong></h3> <p>尽可能使用正确的 HTML。</p> <pre> <code class="language-css"><!-- Not recommended --> <title>Test</title> <article>This is only a test.</code></pre> <pre> <code class="language-css"><!-- Recommended --> <!DOCTYPE html> <meta charset="utf-8"> <title>Test</title> <article>This is only a test.</article></code></pre> <h3><strong>语义化</strong></h3> <p>根据使用场景选择正确的 HTML 元素（有时被错误的称为“标签”）。例如，使用 h1 元素创建标题，p 元素创建段落，a 元素创建链接等等。正确的使用 HTML 元素对于可访问性、可重用性以及编码效率都很重要。</p> <pre> <code class="language-css"><!-- Not recommended --> <div onclick="goToRecommendations();">All recommendations</div></code></pre> <pre> <code class="language-css"><!-- Recommended --> <a href="recommendations/">All recommendations</a></code></pre> <h3><strong>多媒体元素降级</strong></h3> <p>对于像图片、视频、canvas 动画等多媒体元素，确保提供其他可访问的内容。图片可以使用替代文本（alt），视频和音频可以使用文字版本。</p> <pre> <code class="language-css"><!-- Not recommended --> <img src="spreadsheet.png"></code></pre> <pre> <code class="language-css"><!-- Recommended --> <img src="spreadsheet.png" alt="Spreadsheet screenshot."></code></pre> <h3><strong>关注分离</strong></h3> <p>标记、样式和脚本分离，确保相互耦合最小化。</p> <h3><strong>实体引用</strong></h3> <p>如果团队中文件和编辑器使用同样的编码方式，就没必要使用实体引用，如 — ， ” ， ☺ ，除了一些在 HTML 中有特殊含义的字符（如 < 和 &）以及不可见的字符（如空格）。</p> <pre> <code class="language-css"><!-- Not recommended --> The currency symbol for the Euro is “&eur;”.</code></pre> <pre> <code class="language-css"><!-- Recommended --> The currency symbol for the Euro is “€”.</code></pre> <h3><strong>type 属性</strong></h3> <p>在引用样式表和脚本时，不要指定 type 属性，除非不是 CSS 或 JavaScript。</p> <p>因为 HTML5 中已经默认指定样式变的 type 是 text/css，脚本的type 是 text/javascript。</p> <pre> <code class="language-css"><!-- Not recommended --> <link rel="stylesheet" href="//www.google.com/css/maia.css" type="text/css"></code></pre> <pre> <code class="language-css"><!-- Recommended --> <link rel="stylesheet" href="//www.google.com/css/maia.css"></code></pre> <pre> <code class="language-css"><!-- Not recommended --> <script src="//www.google.com/js/gweb/analytics/autotrack.js" type="text/javascript"></script></code></pre> <pre> <code class="language-css"><!-- Recommended --> <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script></code></pre> <h2><strong>HTML 格式规范</strong></h2> <h3><strong>HTML 引号</strong></h3> <p>属性值用双引号。</p> <pre> <code class="language-css"><!-- Not recommended --> <a class='maia-button maia-button-secondary'>Sign in</a></code></pre> <pre> <code class="language-css"><!-- Recommended --> <a class="maia-button maia-button-secondary">Sign in</a></code></pre> <h2><strong>CSS 风格规范</strong></h2> <h3><strong>ID 和 Class 命名</strong></h3> <p>使用有含义的 id 和 class 名称。</p> <pre> <code class="language-css">/* Not recommended: meaningless */ #yee-1901 {} /* Not recommended: presentational */ .button-green {} .clear {}</code></pre> <pre> <code class="language-css">/* Recommended: specific */ #gallery {} #login {} .video {} /* Recommended: generic */ .aux {} .alt {}</code></pre> <h3><strong>ID 和 Class 命名风格</strong></h3> <p>id 和 class 应该尽量简短，同时要容易理解。</p> <pre> <code class="language-css">/* Not recommended */ #navigation {} .atr {}</code></pre> <pre> <code class="language-css">/* Recommended */ #nav {} .author {}</code></pre> <h3><strong>选择器</strong></h3> <p>除非需要，否则不要在 id 或 class 前加元素名。</p> <pre> <code class="language-css">/* Not recommended */ ul#example {} div.error {}</code></pre> <pre> <code class="language-css">/* Recommended */ #example {} .error {}</code></pre> <h3><strong>属性简写</strong></h3> <p>尽量使用 CSS 中可以简写的属性 (如 font)，可以提高编码效率以及代码可读性。</p> <pre> <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> <code class="language-css">/* Recommended */ border-top: 0; font: 100%/1.6 palatino, georgia, serif; padding: 0 1em 2em;</code></pre> <h3><strong>0 和单位</strong></h3> <p>值为 0 时不用添加单位。</p> <pre> <code class="language-css">margin: 0; padding: 0;</code></pre> <h3><strong>开头的 0</strong></h3> <p>值在 -1 和 1 之间时，不需要加 0。</p> <pre> <code class="language-css">font-size: .8em;</code></pre> <h3><strong>16进制表示法</strong></h3> <pre> <code class="language-css">/* Not recommended */ color: #eebbcc;</code></pre> <pre> <code class="language-css">/* Recommended */ color: #ebc;</code></pre> <h3><strong>前缀</strong></h3> <p>使用带前缀的命名空间可以防止命名冲突，同时提高代码可维护性。</p> <pre> <code class="language-css">.adw-help {} /* AdWords */ #maia-note {} /* Maia */</code></pre> <h3><strong>ID 和 Class 命名分隔符</strong></h3> <p>选择器中使用连字符可以提高可读性。</p> <pre> <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> <code class="language-css">/* Recommended */ #video-id {} .ads-sample {}</code></pre> <h2><strong>CSS 格式规范</strong></h2> <h3><strong>书写顺序</strong></h3> <p>按照属性首字母顺序书写 CSS 易于阅读和维护，排序时忽略带有浏览器前缀的属性。</p> <pre> <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> <h3><strong>块级内容缩进</strong></h3> <p>为了反映层级关系和提高可读性，块级内容都应缩进。</p> <pre> <code class="language-css">@media screen, projection { html { background: #fff; color: #444; } }</code></pre> <h3><strong>声明结束</strong></h3> <p>每行 CSS 都应以分号结尾。</p> <pre> <code class="language-css">/* Not recommended */ .test { display: block; height: 100px }</code></pre> <pre> <code class="language-css">/* Recommended */ .test { display: block; height: 100px; }</code></pre> <h3><strong>属性名结尾</strong></h3> <p>属性名和值之间都应有一个空格。</p> <pre> <code class="language-css">/* Not recommended */ h3 { font-weight:bold; }</code></pre> <pre> <code class="language-css">/* Recommended */ h3 { font-weight: bold; }</code></pre> <h3><strong>声明样式块的分隔</strong></h3> <p>在选择器和 {} 之间用空格隔开。</p> <pre> <code class="language-css">/* Not recommended: missing space */ #video{ margin-top: 1em; } /* Not recommended: unnecessary line break */ #video { margin-top: 1em; }</code></pre> <pre> <code class="language-css">/* Recommended */ #video { margin-top: 1em; }</code></pre> <h3><strong>选择器分隔</strong></h3> <p>每个选择器都另起一行。</p> <pre> <code class="language-css">/* Not recommended */ a:focus, a:active { position: relative; top: 1px; }</code></pre> <pre> <code class="language-css">/* Recommended */ h1, h2, h3 { font-weight: normal; line-height: 1.2; }</code></pre> <h3><strong>规则分隔</strong></h3> <p>规则之间都用空行隔开。</p> <pre> <code class="language-css">html { background: #fff; } body { margin: auto; width: 50%; }</code></pre> <h3><strong>CSS 引号</strong></h3> <p>属性选择器和属性值用单引号，URI 的值不需要引号。</p> <pre> <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> <code class="language-css">/* Recommended */ @import url(//www.google.com/css/maia.css); html { font-family: 'open sans', arial, sans-serif; }</code></pre> <h2><strong>CSS 元规则</strong></h2> <h3><strong>分段注释</strong></h3> <p>用注释把 CSS 分成各个部分。</p> <pre> <code class="language-css">/* Header */ #adw-header {} /* Footer */ #adw-footer {} /* Gallery */ .adw-gallery {}</code></pre> <h2><strong>结语</strong></h2> <p>坚持遵循代码规范。</p> <p>写代码前先看看周围同事的代码，然后决定代码风格。</p> <p>代码规范的意义在于提供一个参照物。这里提供了一份全局的规范，但是你也得参照公司内部的规范，否则阅读你代码的人会很痛苦。</p> <p> </p> <p>来自：https://segmentfault.com/a/1190000007023192</p> <p> </p>