规范:你是否常常碰到以下问题:你总是看不懂他写的代码,或者读起来很吃力;你需要改他的代码却无从下手,或总是要去问他这里是什么改了会不会影响其他代码;你和他一起开发一个产品,你总是怕代码和他有冲突或互相影响;你的代码在多次维护任务之后变得越来越臃肿,越来越难以维护。解决以上问题只需一种方法——读我们的规范!
整体结构
HTML基础设施
文件应以“”首行顶格开始,推荐使用“”。
必须申明文档的编码charset,且与文件本身编码保持一致,推荐使用UTF-8编码
根据页面内容和需求填写适当的keywords和description。
页面title是极为重要的不可缺少的一项。
1 |
|
结构顺序和视觉顺序基本保持一致
按照从上至下、从左到右的视觉顺序书写HTML结构。
有时候为了便于搜索引擎抓取,我们也会将重要内容在HTML结构顺序上提前。
用div代替table布局,可以使HTML更具灵活性,也方便利用CSS控制。
table不建议用于布局,但表现具有明显表格形式的数据,table还是首选。
结构、表现、行为三者分离,避免内联
使用link将css文件引入,并置于head中。
使用script将js文件引入,并置于body底部。
保持良好的简洁的树形结构
每一个块级元素都另起一行,每一行都使用Tab缩进对齐(head和body的子元素不需要缩进)。删除冗余的行尾的空格。
使用4个空格代替1个Tab(大多数编辑器中可设置)。
对于内容较为简单的表格,建议将tr写成单行。
你也可以在大的模块之间用空行隔开,使模块更清晰。
1 | <body> |
另外,请做到以下几点
- 结构上如果可以并列书写,就不要嵌套。如果可以写成
<div></div><div></div>
那么就不要写成<div><div></div></div>
- 如果结构已经可以满足视觉和语义的要求,那么就不要有额外的冗余的结构。比如
<div><h2></h2></div>
已经能满足要求,那么就不要再写成<div><div><h2></h2></div></div>
- 一个标签上引用的className不要过多,越少越好。比如不要出现这种情况:
<div class="class1 class2 class3 class4"></div>
- 对于一个语义化的内部标签,应尽量避免使用className。比如在这样一个列表中,li标签中的itm应去除:
<ul class="m-help"><li class="itm"></li><li class="itm"></li></ul>
代码格式
说明文案的注释方法
采用类似标签闭合的写法,与HTML统一格式;注释文案两头空格,与CSS注释统一格式。
开始注释:(文案两头空格)。
结束注释:(文案前加“/”符号,类似标签的闭合)。
允许只有开始注释!
1 | <!-- 头部 --> |
代码本身的注释方法
单行代码的注释也保持同行,两端空格;多行代码的注释起始和结尾都另起一行并左缩进对齐。
1 | <!-- <h1 class="m-logo"><a href="#">LOGO</a></h1> --> |
HTML注释在IE6中的BUG
如果两个浮动元素之间存在注释,那么可能导致布局错位或文字的BUG。
所以,这种情况下,我们通常将注释去掉,或者索性采用模板语言(ftl、vm)的注释。
严格的嵌套
尽可能以最严格的xhtml strict标准来嵌套,比如内联元素不能包含块级元素等等。
正确闭合标签且必须闭合。
严格的属性
属性和值全部小写,每个属性都必须有一个值,每个值必须加双引号。
没有值的属性必须使用自己的名称做为值(checked、disabled、readonly、selected等等)。
可以省略style标签和script标签的type属性。
常用的标签
| 标签 | 语义 | 嵌套常见错误 | 常用属性(加粗的为不可缺少的或建议的) |
| —– | —– |:—-:| —– |:—-:|
| a | 超链接/锚 | a不可嵌套a | href,name,title,rel,target |
| br | 换行 | | |
| button | 按钮 | 不可嵌套表单元素 | type,disabled |
| dd | 定义列表中的定义(描述内容) | 只能以dl为父容器,对应一个dt | |
| del | 文本删除 | | |
| div | 块级容器 | | |
| dl | 定义列表 | 只能嵌套dt和dd | |
| dt | 定义列表中的定义术语 | 只能以dl为父容器,对应多个dd | |
| em | 强调文本 | | |
| form | 表单 | action |,target,method,name |
| h1 | 标题 | 从h1到h6,不可嵌套块级元素 | |
| iframe | 内嵌一个网页 | frameborder |,width,height,src,scrolling,name |
| img | 图像 | alt |,src,width,height |
| input | 各种表单控件 | type |,name,value,checked,disabled,maxlength,readonly,accesskey |
| label | 标签为input元素定义标注 | for | |
| li | 列表项 | 只能以ul或ol为父容器 | |
| link | 引用样式或icon | 不可嵌套任何元素 | type,rel,href |
| meta | 文档信息 | 只用于head | content,http-equiv,name |
| ol | 有序列表 | 只能嵌套li | |
| option | select中的一个选项 | 仅用于select | value,selected,disabled |
| p | 段落 | 不能嵌套块级元素 | |
| script | 引用脚本 | 不可嵌套任何元素 | type,src |
| select | 列表框或下拉框 | 只能嵌套option或optgroup | name,disabled,multiple |
| span | 内联容器 | | |
| strong | 强调文本 | | |
| style | 引用样式 | 不可嵌套任何元素 | type,media |
| sub | 下标 | | |
| sup | 上标 | | |
| table | 表格 | 只可嵌套表格元素 | width,align,background,cellpadding,cellspacing,summary,border |
| tbody | 表格主体 | 只用于table | |
| td | 表格中的单元格 | 只用于tr | colspan,rowspan |
| textarea | 多行文本输入控件 | name |,accesskey,disabled,readonly,rows,cols |
| tfoot | 表格表尾 | 只用于table | |
| th | 表格中的标题单元格 | 只用于tr | colspan,rowspan |
| thead | 表格表头 | 只用于table | |
| title | 文档标题 | 只用于head | |
| tr | 表格行 | 嵌套于table或thead、tbody、tfoot | |
| ul | 无序列表 | 只能嵌套li | |
内容语义
CSS文件的分类
内容类型决定使用的语义标签
在网页中某种类型的内容必定需要某种特定的HTML标签来承载,也就是我们常常提到的根据你的内容语义化HTML结构。
加强“资源型”内容的可访问性和可用性
在资源型的内容上加入描述文案,比如给img添加alt属性,在audio内加入文案和链接等等。
加强“不可见”内容的可访问性
背景图上的文字应该同时写在html中,并使用css使其不可见,有利于搜索引擎抓取你的内容,也可以在css失效的情况下看到内容。
适当使用实体
以实体代替与HTML语法相同的字符,避免浏览解析错误。
常用HTML字符实体(建议使用实体):
字符 | 名称 | 实体名 | 实体数 |
---|---|---|---|
“ | 双引号 | " | " |
& | &符 | & | & |
< | 左尖括号(小于号) | < | < |
> | 右尖括号(大于号) | > | > |
空格 | |||
中文全角空格 |
常用特殊字符实体(不建议使用实体):
字符 | 名称 | 实体名 | 实体数 |
---|---|---|---|
¥ | 元 | ¥ | ¥ |
¦ | 断竖线 | ¦ | ¦ |
© | 版权 | © | © |
® | 注册商标R | ® | ® |
™ | 商标TM | ™ | ™ |
· | 间隔符 | · | · |
« | 左双尖括号 | « | « |
» | 右双尖括号 | » | » |
° | 度 | ° | ° |
× | 乘 | × | × |
÷ | 除 | ÷ | ÷ |
‰ | 千分比 | ‰ | ‰ |
邮件内容
邮件环境
邮件内容所在上下文或者说所在外部容器(以下简称环境)都是由邮箱服务商决定的,这就要求邮件内容需要在任何一种情况下都要正确显示。
这些环境可能是以下某几种情况:
- 可能是个iframe,你的内容是被放在body里面的;可能只是个div,你的内容就被放在这个div里面。
- 可能邮箱自身设置了些css,他可能对你产生未知的影响。
- 可能根本没有申明doctype,即使申明了,也不是你想要的doctype。
避免被嵌套在不正确的容器里
惑:因为容器可能是body或div,所以,我们邮件内容不应该是一个完整的html。
解:所以邮件内容应该是以div为根节点的html片段。
避免css冲突或被覆盖
惑:因为环境中可能已经设置了css,比如一些reset、一些.class。
解:所以我们只能使用行内style来确保我们的效果,并且在内容根节点上设置基础style,并且尽量使用div、span等无语义标签。
1 | <!-- 根节点 --> |
避免盒模型错误
惑:因为doctype的不确定性,我们在写style的时候,应该考虑无论doctype是什么情况,都可以正常显示,doctype影响最大的就是盒模型的解析。
解:所以我们要将盒模型拆分开来写,比如我们将原本要定义在某个div上的height和padding分别写到这个div和他的父元素或子元素上。
1 | <div style="height:100px;padding:20px 0;">内容</div> |
其他注意事项
因为只能使用行内style,所以清除浮动需要使用额外标签。
避免使用绝对定位,可能会被过滤。
避免使用js,可能会被过滤。
避免使用table布局,不易于修改维护。
背景图片或内容图片上的文字信息,必须在代码中可见。
如果没有特殊要求,所有a链接都要从新窗口打开,即target=”_blank”,且a标签内容不能为空。
所有链接必须设置使用颜色、是否下划线,即style=”text-decoration:;color:;”。
重点检查ie!!!
1 | <div style="width:600px;text-align:left;color:#000;font:normal 12px/15px simsun;background:#d9d9d9;"> |
发现的问题及解决方案
问题:部分智能手机的邮件客户端可能会有只显示部分的bug(宽度被截)。
解决:在外面套一个同宽的table即可。
1 | <table width="600" cellpadding="0" cellspacing="0" border="0"><tr><td> |
使用框架
推荐使用 email框架 来创建邮件内容。
1 | <table width="600" cellpadding="0" cellspacing="0" border="0"><tbody><tr><td> |