This is an old revision of the document!
如果没有特别说明,可以参照Google或阿里的编码规范
参考资料:
* [Google Style Guide – HTML/CSS](https://google.github.io/styleguide/htmlcssguide.html)
# 文件命名
文件命名采用全小写字母加-分割的规则命名,例如user-add.html
# HTML/CSS通用编码规范
## 文件格式化
### 缩进
使用2个空格作为缩进,请勿使用tab缩进,也不要使用tab和空格的混合缩进
### 大小写
仅使用小写,包括HTML元素名称、属性、属性值(text/CDATA除外),CSS选择器、属性和属性值
### 行尾不留空格
代码行尾不留空格
## 元数据规则/Meta Rules
### 文件编码
使用UTF-8(no BOM)编码
### TODO
在必要的地方添加TODO,例如由于时间关系,想到但是还没有时间编写的逻辑代码等。
# HTML编码规范
## Document类型
Document类型采用HTML5,而不是html和xhtml。
## HTML有效性
HTML应该是有效的,例如,除非是空元素(例如<br>),否则HTML元素应该成对出现,例如<title>Title</title>,而不是<title>Tile。
## 语义
根据HTML元素的语义使用,例如p元素应该是段落,a元素应该是链接。
## 多媒体备用文字
多媒体内容应该提供alt属性,例如img应该有alt属性。主要好处是两个方面,一是网络不好时一样可以让用户看懂图标的含义,二是方便有阅读障碍的人(例如盲人)通过阅读软件读取网页内容。
## 关注点拆分
将HTML内容与css样式表以及js动作分开,保持HTML的简洁和专注。
## 特殊符号编码
不需要将特殊符号进行编码,例如“不需要转换为&ldquo。
## type属性
如果引用CSS和JavaScript,则不需要指定type,因为所有的浏览器都会自动指定这两种类型,这样做可以保证代码更加简洁
## 格式化
每个元素单独一行
## 引号
元素属性值使用双引号
# CSS编码规范