概述

本文档定义了HTML/CSS的编写格式和风格规则。它旨在提高合作和代码质量,并使其支持基础架构。适用于HTML/CSS文件，包括GSS文件。 只要代码质量是可以被维护的，就能很好的被工具混淆、压缩和合并。

html

样式规则

协议

嵌入式资源书写省略协议头

  • 省略图像、媒体文件、样式表和脚本等URL协议头部声明 ( http: , https: )。如果不是这两个声明的URL则不省略。
  • 省略协议声明，使URL成相对地址，防止内容混淆问题和导致小文件重复下载。




/* 不推荐 */
.example {
  background: url(http://www.google.com/images/example);
}
/* 推荐 */
.example {
  background: url(//www.google.com/images/example);
}

排版规则

缩进

每次缩进两个空格。

大小写

只用小写字母。

行尾空格

删除行尾白空格。

元数据规则

编码

用不带BOM头的 UTF-8编码。

让你的编辑器用没有字节顺序标记的UTF-8编码格式进行编写。

在HTML模板和文件中指定编码 <meta charset="utf-8">。 不需要制定样式表的编码，它默认为UTF-8。

（更多有关于编码的信息和怎样指定它，请查看 Character
Sets & Encodings in XHTML, HTML and CSS。）

注释

尽可能的去解释你写的代码。

用注释来解释代码：它包括什么，它的目的是什么，它能做什么，为什么使用这个解决方案，还是说只是因为偏爱如此呢？

（本规则可选，没必要每份代码都描述的很充分，它会增重HTML和CSS的代码。这取决于该项目的复杂程度。）

活动的条目

用 TODO 标记代办事项和正活动的条目

只用 TODO 来强调代办事项， 不要用其他的常见格式，例如 @@ 。

附加联系人（用户名或电子邮件列表），用括号括起来，例如 TODO(contact) 。

可在冒号之后附加活动条目说明等，例如 TODO: 活动条目说明 。

{# TODO(cha.jn): 重新置中 #}

Test



    
  
  • Apples
    • 
  
  • Oranges
    •

HTML代码风格规则

文档类型

请使用HTML5标准。

HTML代码有效性

尽量使用有效的HTML代码。

编写有效的HTML代码，否则很难达到性能上的提升。

用类似这样的工具 W3C
HTML validator
来进行测试。

HTML代码有效性是重要的质量衡量标准，并可确保HTML代码可以正确使用。 


Test

This is only a test.



Test

This is only a test.

语义

根据HTML各个元素的用途而去使用它们。

使用元素 (有时候错称其为“标签”) 要知道为什么去使用它们和是否正确。 例如，用heading元素构造标题， p 元素构造段落, a 元素构造锚点等。

根据HTML各个元素的用途而去使用是很重要的，它涉及到文档的可访问性、重用和代码效率等问题。



All recommendations


All recommendations

多媒体后备方案

为多媒体提供备选内容。

对于多媒体，如图像，视频，通过 canvas 读取的动画元素，确保提供备选方案。 对于图像使用有意义的备选文案（ alt ） 对于视频和音频使用有效的副本和文案说明。

提供备选内容是很重要的，原因：给盲人用户以一些提示性的文字，用 @alt 告诉他这图像是关于什么的，给可能没理解视频或音频的内容的用户以提示。

（图像的 alt 属性会产生冗余，如果使用图像只是为了不能立即用CSS而装饰的 ，就不需要用备选文案了，可以写 alt="" 。）




电子表格截图

关注点分离

将表现和行为分开。

严格保持结构 （标记），表现 （样式），和行为 （脚本）分离, 并尽量让这三者之间的交互保持最低限度。

确保文档和模板只包含HTML结构， 把所有表现都放到样式表里，把所有行为都放到脚本里。

此外，尽量使脚本和样式表在文档与模板中有最小接触面积，即减少外链。

将表现和行为分开维护是很重要滴，因为更改HTML文档结构和模板会比更新样式表和脚本更花费成本。 



HTML sucks




HTML sucks


I’ve read about this on a few sites but now I’m sure:
  HTML is stupid!!1

I can’t believe there’s no way to control the styling of
  my website without doing everything all over again!



My first CSS-only redesign


My first CSS-only redesign


I’ve read about this on a few sites but today I’m actually
  doing it: separating concerns and avoiding anything in the HTML of
  my website that is presentational.

It’s awesome!

实体引用

不要用实体引用。

不需要使用类似 &mdash;、&rdquo; 和 &#x263a; 等的实体引用, 假定团队之间所用的文件和编辑器是同一编码（UTF-8）。

在HTML文档中具有特殊含义的字符（例如

<

和

&
)为例外， 噢对了，还有 “不可见” 字符 （例如no-break空格）。 


欧元货币符号是 “&eur;”。

欧元货币符号是 “€”。

可选标签

省略可选标签（可选）。

出于优化文件大小和校验， 可以考虑省略可选标签，哪些是可选标签可以参考 HTML5
specification。

（这种方法可能需要更精准的规范来制定，众多的开发者对此的观点也都不同。考虑到一致性和简洁的原因，省略所有可选标记是有必要的。） 




  
    Spending money, spending bytes
  
  
    
Sic.

  



Saving money, saving bytes

Qed.

type属性

在样式表和脚本的标签中忽略

type

属性

在样式表（除非不用 CSS）和脚本（除非不用 JavaScript）的标签中 不写

type

属性。

HTML5默认

type

为

text/css


和

text/javascript


类型，所以没必要指定。即便是老浏览器也是支持的。

HTML代码格式规则

每个块元素、列表元素或表格元素都独占一行，每个子元素都相对于父元素进行缩进。

独立元素的样式（as CSS allows elements to assume a different role per

display

property), 将块元素、列表元素或表格元素都放在新行。

另外，需要缩进块元素、列表元素或表格元素的子元素。

（如果出现了列表项左右空文本节点问题，可以试着将所有的

li

元素都放在一行。) 


  
Space, the final frontier.




    
  
  • Moe
  
  • Larry
  
  • Curly




  
    

      Income
      Taxes
  

    

      $ 5.00
      $ 4.50

相关资源