君语贤
时光静好,与君语;细水流年,与君同;繁华落尽,与君老...

前端设计>知识整理>正文

Web前端开发代码规范——HTML/CSS规范

2019-01-24 12:03 君语贤Web代码规范前端开发

Web前端开发代码规范——HTML/CSS规范

 HTML/CSS规范

2.1 浏览器兼容

根据公司业务要求而定,一般:

主流程测试:Chrome 30+、IE9+;

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

2.2 html代码规范

2.2.1声明与编码

1、html头部声明统一:

<!DOCTYPE html>

2、页面编码统一:

<meta charset="UTF-8"> <!-- ie6也支持,无须担心 -->

2.2.2格式缩进

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

2.2.3 模块注释

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

<!-- start: XXX模块 -->  …<!-- end: XXX模块 -->

或者:

<!-- XXX模块 -->  …<!-- /XXX模块 -->

2.2.4标签与属性

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

<div data-bgColor="red"></div>$('div').data('bgColor');  // 取不到,已自动被浏览器转成了data-bgcolor

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

// 禁止<div id=mainframe> 或 <div id='mainframe'>// 推荐<div id="mainframe">

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

// 禁止<p><b></p></b>// 推荐<p><b></b></p>// 禁止inline级标签嵌套block级标签<span><div></div></span>

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

5、img标签中必须添加alt属性。如:<img src="…" alt="logo" />

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

<h1>标题<h1><lable for="user">用户名:</lable><input name="username" id="user">

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

2.3 CSS代码规范

2.3.1 CSS引用规范

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

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

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

<link rel="stylesheet" href="xxx.css"> <!-- type="text/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等)

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,禁止用无语义的<p box-sizing: border-box; margin: 1.5em 0px; outline: 0px; white-space: normal; color: rgb(51, 51, 51);">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,否则会产生重叠现象。

本文链接:https://www.weguiding.com/zhishi/205.html