Html Style Guide

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 18

DownloadHtml-style-guide
Open PDF In BrowserView PDF
HTML编码规范
1 前言
2 代码风格
2.1 缩进与换行
2.2 命名
2.3 标签
2.4 属性
3 通用
3.1 DOCTYPE
3.2 编码
3.3 CSS 和 JavaScript 引入
4 head
4.1 title
4.2 favicon
4.3 viewport
5 图片
6 表单
6.1 控件标题
6.2 按钮
6.3 可访问性 (A11Y)
7 多媒体
8 模板中的 HTML

1 前言
HTML 作为描述网页结构的超文本标记语言,在百度一直有着广泛的应用。
本文档的目标是使 HTML 代码风格保持一致,容易被理解和被维护。

2 代码风格
2.1 缩进与换行
[强制] 使用 2 个空格做为一个缩进层级,不允许使用 4 个空格 或 tab 字
符。
解释:
对于非 HTML 标签之间的缩进,比如 script 或 style 标签内容缩进,与 script
或 style 标签的缩进同级。
示例:

  • first
  • second
[建议] 每行不得超过 120 个字符。 解释: 过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性,不做硬性要 求。 2.2 命名 [强制] class 必须单词全字母小写,单词间以 - 分隔。 [强制] class 必须代表相应模块或部件的内容或功能,不得以样式信息进行 命名。 示例:
[强制] 元素 id 必须保证页面唯一。 解释: 同一个页面中,不同的元素包含相同的 id ,不符合 id 的属性含义。并且 使用 document.getElementById 时可能导致难以追查的问题。 [建议] id 建议单词全字母小写,单词间以 - 分隔。同项目必须保持风格 一致。 [建议] id 、 class 命名,在避免冲突并描述清楚的前提下尽可能短。 示例: id="nav">
bad --> id="navigation">

[强制] 禁止为了 hook 脚本 ,创建无样式信息的 class 。 解释: 不允许 class 只用于让 JavaScript 选择某些元素, class 应该具有明确的 语义和样式。否则容易导致 CSS class 泛滥。 使用 id 、属性选择作为 hook 是更好的方式。 [强制] 同一页面,应避免使用相同的 name 与 id 。 解释: IE 浏览器会混淆元素的 id 和 name 属性, document.getElementById 可能获得不期望的元素。所以在对元素的 id 与 name 属性的命名需要非常 小心。 一个比较好的实践是,为 id 和 name 使用不同的命名法。 示例:
```` ### 2.3 标签 #### [强制] 标签名必须使用⼩写字母。 示例: ```html

Hello StyleGuide!

Hello StyleGuide!

[强制] 对于无需自闭合的标签,不允许自闭合。 解释: 常见无需自闭合标签有 input 、 br 、 img 、 hr 等。 示例: [强制] 对 HTML5 中规定允许省略的闭合标签,不允许省略闭合标签。 解释: 对代码体积要求非常严苛的场景,可以例外。比如:第三方页面使用的投放 系统。 示例: [强制] 标签使用必须符合标签嵌套规则。 解释: 比如 div 不得置于 p 中, tbody 必须置于 table 中。 详细的标签嵌套规则参见HTML DTD中的 Elements 定义部分。 [建议] HTML 标签的使用应该遵循标签的语义。 解释: 下面是常见标签语义 • p - 段落 • h1,h2,h3,h4,h5,h6 - 层级标题 • strong,em - 强调 • ins - 插入 • del - 删除 • abbr - 缩写 • code - 代码标识 • cite - 引述来源作品的标题 • q - 引用 • blockquote - 一段或长篇引用 • ul - 无序列表 • ol - 有序列表 • dl,dt,dd - 定义列表 示例:

Esprima serves as an important building block for some JavaS

Esprima serves as an important building block f [建议] 在 CSS 可以实现相同需求的情况下不得使用表格进行布局。 解释: 在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格 要求的场景允许例外,如多列复杂表单。 [建议] 标签的使用应尽量简洁,减少不必要的标签。 示例: 2.4 属性 [强制] 属性名必须使用小写字母。 示例: ...
...
[强制] 属性值必须用双引号包围。 解释: 不允许使用单引号,不允许不使用引号。 示例: [建议] 布尔类型的属性,建议不添加属性值。 示例: [建议] 自定义属性建议以 xxx- 为前缀,推荐使用 data- 。 解释: 使用前缀有助于区分自定义属性和标准定义的属性。 示例:
    3 通用 3.1 DOCTYPE [强制] 使用 HTML5 的 doctype 来启用标准模式,建议使用大写的 DOCTYP E。 示例: [建议] 启用 IE Edge 模式。 示例: [建议] 在 html 标签上设置正确的 lang 属性。 解释: 有助于提高页面的可访问性,如:让语音合成工具确定其所应该采用的发 音,令翻译工具确定其翻译语言等。 示例: 3.2 编码 [强制] 页面必须使用精简形式,明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。 解释: 见 HTML5 Charset能用吗 一文。 示例: ...... ...... [建议] HTML 文件使用无 BOM 的 UTF-8 编码。 解释: UTF-8 编码具有更广泛的适应性。 BOM 在使用程序或工具处理文件时可能 造成不必要的干扰。 3.3 CSS 和 JavaScript 引入 [强制] 引入 CSS 时必须指明 rel="stylesheet" 。 示例: [建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。 解释: text/css 和 text/javascript 是 type 的默认值。 [建议] 展现定义放置于外部 CSS 中,行为定义放置于外部 JavaScript 中。 解释: 结构-样式-行为的代码分离,对于提高代码的可阅读性和维护性都有好处。 [建议] 在 head 中引入页面需要的所有 CSS 资源。 解释: 在页面渲染的过程中,新的CSS可能导致元素的样式重新计算和绘制,页面 闪烁。 [建议] JavaScript 应当放在页面末尾,或采用异步加载。 解释: 将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必 要,请遵守此条建议。 示例: [建议] 移动环境或只针对现代浏览器设计的 Web 应用,如果引用外部资源 的 URL 协议部分与页面相同,建议省略协议前缀。 解释: 使用 protocol-relative URL 引入 CSS,在 IE7/8 下,会发两次请求。 是否使用 protocol-relative URL 应充分考虑页面针对的环境。 示例:

    Navigation menu