商品详细信息的代码html_Web前端，你该有的代码规范

私信我或关注微信号：狮范儿，回复：学习，获取免费学习资源包。

一、 引言

对于一个多人团队来说，制定一个统一的规范是必要的，因为个性化的东西无法产生良好的聚合效果，规范化可以提高编码工作效率，使代码保持统一的风格，以便于代码整合和后期维护。

二、 HTML/CSS规范

2.1 浏览器兼容

根据公司业务要求而定，一般：

主流程测试：Chrome 30+、IE9+；

完整测试：Chrome 21、IE8+、360浏览器、微信webview/QQ手机浏览器。

2.2 html代码规范

2.2.1声明与编码

1、html头部声明统一：

2、页面编码统一：

2.2.2格式缩进

html编码统一格式化显示，使用一个Tab键进行分层缩进 (2个空格宽度)，使整个页面结构层次清晰，方便阅读和修改。

2.2.3 模块注释

html较大独立模块之间注释格式统一使用：

 …

或者：

 …

2.2.4标签与属性

1、由于html标签和属性不区别大小写，所有建议都采用小写，尤其是自定义标签和属性名，否定js中取不到，如：

2、所有html属性必须添加双引号(非单引号)。

// 禁止

或

// 推荐

3、所有标签必须采用合理嵌套。

// 禁止

4、所有等特殊符号(非标签一部分)用编码表示。< 编码成< ，>编码成>，&编码成&

5、img标签中必须添加alt属性。如：

6、标签在运用时，应尽量使用语义化标签，如:

标题

用户名：

在语义不明显，既可用div也可用p时，应优先考虑p标签。

2.3 CSS代码规范

2.3.1 CSS引用规范

1、所有CSS均为外部调用，不得在页面书写任何内部样式或行内样式；

2、html页面引入样式文件：

统一使用link标签，少用@import(原生import有加载性能问题)，sass、less、vue.js等文件使用import命令除外(因为最终前端构建工具会将引入文件编译成一个css文件)。

2.3.2 CSS注释规范

1、css头部文档注释( 统一加上@charset声明 )，如下：

@charset "utf-8";/** * @created : 2017/09/15 * @author : Mr.Wang * @version : v1.0 * @desc : XX模块 */

关于"version"，如果对代码有修改更新version版本号，并添加相关注释。

2、内部模块之间注释(建议 @模块英文名，好查找)：

/* @info 商品信息区----------------------------------------------------------------*/.infoArea{}/* 单行注释 */.specArea{}/* @price 商品价格区----------------------------------------------------------------*/.price{}

2.3.3 CSS书写规范

1、样式书写不做强约，可分行或单行

推荐单行，理由：直观、模块之间分隔鲜明，有全局感。

2、样式中属性排序规则：先外部 > 再自身 > 后内部，推荐工具( CSScomb )

 A.)影响文档流的属性(display, position, float, clear, visibility, table-layout等) B.)自身盒模型的属性(width, height, margin, padding, border等) C.)排版相关属性(font, line-height, text-align, text-indent, vertical-align等) D.)装饰性属性(color, background, opacity, cursor等) E.)生成内容的属性(content, list-style, quotes等) B.)自身盒模型的属性(width, height, margin, padding, border等) C.)排版相关属性(font, line-height, text-align, text-indent, vertical-align等) D.)装饰性属性(color, background, opacity, cursor等) E.)生成内容的属性(content, list-style, quotes等)

2、所有CSS属性和值必须采用小写的形式。如：FONT-SIZE:12PX必须改为font-size:12px；

3、关于css背景图片(关键字：合并，缩写，去引号), 引号不是必须的，而且在某些浏览器上加引号反而出错：

// 不推荐.canbox{ background-color: #ff6600; background-image: url("/img/xxx.png");}// 推荐(合并、去除引号).canbox { background: #f60 url(/img/xxx.png); }

4、属性为0值，去除单位。

// 不推荐.wrap{ margin: 0px 0px 5px 8px;}// 推荐.wrap { margin: 0 0 5px 8px;}

5、所有CSS的命名应语义化，如：回复框，.replyBox{…}，禁止用拼音缩写命名，如.hfk{…}。

6、清除浮动时用.clearfix，禁止用无语义的

7、用来显示动态文本输入的地方，样式里必须加上强制英文换行：

word-break: break-all; word-wrap: break-word; overflow-x: hidden;

如果要显示省略号则不让其换行：

white-space: nowrap; overflow: hidden; text-overflow: ellipsis;

8、上下相邻的两模块尽量避免混用margin-bottom，margin-top，否则会产生重叠现象。

三、 JavaScript规范

3.1 JS文件引用

1、引入格式：

脚本语言发展至今，也只有js混的最好了，所以type="text/javascript"类型指定可以省去。

2、引入位置：body标签内最后部(非body外面), 减少因载入脚本而造成其他页面内容阻塞的问题(js单线程)。

页面内容….

3、引入方式：html页面中禁止直接编写js代码，统一使用