腾讯html规范,腾讯alloyteam团队前端代码规范.pdf

目录

最佳原则

命名规则

HTML

CSS,SCSS

JavaScript

编辑器配置和构建检查

本文档使用看云构建 -2-

最佳原则

最佳原则

转自 ：腾讯alloyteam团队

坚持制定好的代码规范。

无论团队人数多少 ，代码应该同出一门。

如果你想要为这个规范做贡献或觉得有不合理的地方 ，请访问NewIssue。

本文档使用看云构建 -3-

命名规则

命名规则

项目命名

全部采用小写方式 ，以下划线分隔。

例 ：my_project_name

目录命名

参照项目命名规则 ；

有复数结构时 ，要采用复数命名法。

例 ：scripts , styles , images , data_models

JS文件命名

参照项目命名规则。

例 ：account_model.js

CSS,SCSS文件命名

参照项目命名规则。

例 ：retina_sprites.scss

HTML文件命名

参照项目命名规则。

例 ：error_report.html

本文档使用看云构建 -4-

HTML

HTML

语法

缩进使用softtab (4个空格 )；

嵌套的节点应该缩进 ；

在属性上 ，使用双引号 ，不要使用单引号 ；

属性名全小写 ，用中划线做分隔符 ；

不要在自动闭合标签结尾处使用斜线 (HTML5规范指出他们是可选的 )；

不要忽略可选的关闭标签 ，例 ：`和 `。

Pagetitle

Hello,world!

HTML5doctype

在页面开头使用这个简单地doctype来启用标准模式 ，使其在每个浏览器中尽可能一致的展

现 ；

虽然doctype不区分大小写 ，但是按照惯例 ，doctype大写 (关于html属性 ，大写还是小

写 )。

...

lang属性

根据HTML5规范 ：

应在html标签上加上lang属性。这会给语音工具和翻译工具帮助 ，告诉它们应当怎么去

本文档使用看云构建 -5-

HTML

发音和翻译。

更多关于 lang 属性的说明在这里 ；

在sitepoint上可以查到语言列表 ；

但sitepoint只是给出了语言的大类 ，例如中文只给出了zh ，但是没有区分香港 ，台湾 ，大

陆。而微软给出了一份更加详细的语言列表 ，其中细分了zh-cn,zh-hk,zh-tw。

...