来自:Web Develop - SegmentFault
链接:https://segmentfault.com/a/1190000007023192
(点击尾部阅读原文前往)
原文:https://google.github.io/styleguide/htmlcssguide.xml
背景
这篇文章定义了 HTML 和 CSS 的格式和代码规范,旨在提高代码质量和协作效率。
通用样式规范
协议
省略图片、样式、脚本以及其他媒体文件 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>
/* Not recommended */
.example {
background: url(https://www.google.com/images/example);
}
/* Recommended */
.example {
background: url(//www.google.com/images/example);
}
通用格式规范
缩进
一次缩进2个空格,不要使用 tab 或者混合 tab 和空格的缩进。
<ul>
<li>Fantastic
<li>Great
ul>
.example {
color: blue;
}
大小写
以下都应该用小写:
HTML 元素名称,属性,属性值(除非 text/CDATA),CSS 选择器,属性,属性值。
<A HREF="/">HomeA>
<img src="google.png" alt="Google">
/* Not recommended */
color: #E5E5E5;
/* Recommended */
color: #e5e5e5;
结尾空格
结尾空格不仅多余,而且在比较代码时会更麻烦。
<p>What?_
<p>Yes please.
通用元规范
编码
在 HTML 中通过指定编码方式,CSS 中不需要指定,因为默认是 UTF-8。
注释
使用注释来解释代码:包含的模块,功能以及优点。
任务项
用 TODO 来标记待办事项,而不是用一些其他的标记,像 @@。
<ul>
<li>Applesli>
<li>Orangesli>
ul>
HTML 风格规范
文档类型
HTML 文档应使用 HTML5 的文档类型:。
孤立标签无需封闭自身,
不要写成
。
HTML 正确性
尽可能使用正确的 HTML。
<title>Testtitle>
<article>This is only a test.
<meta charset="utf-8">
<title>Testtitle>
<article>This is only a test.article>
语义化
根据使用场景选择正确的 HTML 元素(有时被错误的称为“标签”)。例如,使用 h1 元素创建标题,p 元素创建段落,a 元素创建链接等等。正确的使用 HTML 元素对于可访问性、可重用性以及编码效率都很重要。
<div
onclick="goToRecommendations();">All recommendationsdiv>
<a href="recommendations/">All recommendationsa>
多媒体元素降级
对于像图片、视频、canvas 动画等多媒体元素,确保提供其他可访问的内容。图片可以使用替代文本(alt),视频和音频可以使用文字版本。
<img src="spreadsheet.png">
<img src="spreadsheet.png" alt="Spreadsheet screenshot.">
关注分离
标记、样式和脚本分离,确保相互耦合最小化。
实体引用
如果团队中文件和编辑器使用同样的编码方式,就没必要使用实体引用,如
—
,
”
,
☺
,除了一些在 HTML 中有特殊含义的字符(如 < 和 &)以及不可见的字符(如空格)。
The currency symbol for the Euro is “&eur;”.
The currency symbol for the Euro is “€”.
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>
HTML 格式规范
HTML 引号
属性值用双引号。
<a class='maia-button maia-button-secondary'>Sign ina>
<a class="maia-button maia-button-secondary">Sign ina>
CSS 风格规范
ID 和 Class 命名
使用有含义的 id 和 class 名称。