前端开发规范
1. 基本原则
基本原则
结构、样式、行为分离
尽量确保文档和模板只包含 HTML 结构,样式都放到样式表里,行为都放到脚本里。
缩进
统一两个空格缩进(总之缩进统一即可),不要使用 Tab 或者 Tab、空格混搭。
文件编码
使用不带 BOM 的 UTF-8 编码。
· 在 HTML中指定编码 ;
· 无需使用 @charset 指定样式表的编码,它默认为 UTF-8
一律使用小写字母
省略外链资源 URL 协议部分
省略外链资源(图片及其它媒体资源)URL 中的 http / https 协议,使 URL 成为相对地址,避免Mixed Content 问题,减小文件字节数。
统一注释
通过配置编辑器,可以提供快捷键来输出一致认可的注释模式。
HTML 注释
·
模块注释
…
· 区块注释
·
CSS 注释
组件块和子组件块以及声明块之间使用一空行分隔,子组件块之间三空行分隔;
JavaScript 注释
· 单行注释
必须独占一行。// 后跟一个空格,缩进与下一行被注释说明的代码一致。
· 多行注释
避免使用 /*…*/ 这样的多行注释。有多行注释内容时,使用多个单行注释。
· 函数/方法注释
· 函数/方法注释必须包含函数说明,有参数和返回值时必须使用注释标识。;
· 参数和返回值注释必须包含类型信息和说明;
· 当函数是内部函数,外部不可访问时,可以使用 @inner 标识;
文件注释
文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。 应该提供文件的大体内容, 它的作者, 依赖关系和兼容性信息。
HTML
通用约定
标签
· 自闭合(self-closing)标签,无需闭合 ( 例如: img input br hr 等 );
· 可选的闭合标签(closing tag),需闭合 ( 例如: 或
服务器托管,北京服务器托管,服务器租用 http://www.fwqtg.net
机房租用,北京机房租用,IDC机房托管, http://www.e1idc.net