1.基本原则
结构、样式和行为分离
尽量确保文档和模板只包含 HTML
结构,样式都放到样式表里,行为都放到脚本里。
缩进
统一两个空格缩进(统一即可),不要使用 Tab
或者 Tab
、空格混搭。
2.文件编码
使用不带 BOM
的UTF-8 编码。
- 在HTML中指定编码
<meta charset="utf-8">
; - 无需使用
@charset
指定样式表的编码,它默认为UTF-8
。
3.一律使用小写字母
1 | <!-- Recommended --> |
1 | /* Recommended */ |
4.省略外链资源 URL 协议部分
省略外链资源(图片及其他媒体资源)URL 中的 http
/ https
协议,使 URL 成为相对地址,避免 Mixed Content
问题,减小文件字节数。
其他协议(ftp
等)的 URL 不省略。
1 | <!-- Recommended --> |
1 | /* Recommended */ |
5.统一注释
通过配置编辑器,可以提供快捷键来输出一致认可的注释模式。
HTML 注释
- 模块注释
1 | <!-- 文章列表列表模块 --> |
- 区块注释
1 | <!-- |
CSS 注释
组件块和子组件块以及声明块之间使用一空行分隔,子组件块之间三空行分隔;
1 | /* ============================ |
JavaScript 注释
- 单行注释:必须独占一行。
//
后跟一个空格,缩进与下一行被注释说明的代码一致。 - 多行注释:避免使用
/* ... */
这样的多行注释。有多行注释内容时,使用多个单行注释。 - 函数/方法注释
- 函数/方法注释必须包含函数说明,有参数和返回值时必须使用注释标识;
- 参数和返回值注释必须包含类型信息和说明;
- 当函数是内部函数,外部不可访问时,可以使用
@inner
标识。
1 | /** |
- 文件注释
文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。应该提供文件的答题内容,它的作者,依赖关系和兼容性信息。 如下:
1 | /** |
6.代码验证
- 使用 W3C HTML Validator 来验证 HTML 代码有效性;
- 使用 W3C CSS Validator 来验证 CSS 代码有效性;
代码验证不是最终目的,真的目的在于让开发者在经过多次这种验证过程后,能够深刻理解到怎样的语法或写法是非标准和不推荐的,即使在某些场景下被迫使用非标准写法,也可以做到心中有数。