Web前端代码规范

第一篇：Web前端代码规范

龙图教育，全球游戏50强教育品牌

www.xiexiebang.com

Web前端代码规范

此项目用于记录规范的、高可维护性的前端代码，这是通过分析 Github 众多前端代码库，总结出来的前端代码书写规范。

前端普适性规范 黄金定律

永远遵循同一套编码规范，可以是这里列出的，也可以是你自己总结的。如果你发现本

规范中有任何错误，敬请指正。

不管有多少人共同参与同一项目，一定要确保每一行代码都像是同一个人编写的。

项目命名

项目名全部采用小写方式，以中划线分隔，禁止驼峰式命名。比如：my-project-name 文件命名

文件命名参照上一条规则，多个单词组成时，采用中划线连接方式，比如说: error-report.html 有复数结构时，要采用复数命名法，比如说： scripts, styles, images, data-models

龙图教育，全球游戏50强教育品牌

www.xiexiebang.com

文件名中只可由小写英文字母a~z、排序数字0~9或间隔符-组成，禁止包含特殊符号，比如空格、$等

为更好的表达语义，文件名使用英文名词命名，或英文简写。

不允许命名带有广告等英文的单词，例如ad,adv,adver,advertising，防止该模块被浏览器当成垃圾广告过滤掉。任何文件的命名均如此。

 index.shtml 引导页&首页  main.shtml 首页

 download.shtml 下载页面  act.html 活动列表页面  video.html 视频  cdkey.html CDKEY页面  base.css 基本样式  layout.css 框架布局  module.css 模块样式  global.css 全局样式  font.css 字体样式  index.css 首页样式  link.css 链接样式  print.css 打印样式

龙图教育，全球游戏50强教育品牌

www.xiexiebang.com

HTML 规范

语法

使用四个空格的缩进，这是保证代码在各种环境下显示一致的唯一方式。

嵌套的节点应该缩进（四个空格）。

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

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

不要忽略可选的关闭标签（例如，和

第二篇：Web前端工作总结

Web前端学习总结

一.名词解释 1.横切

在固定页面的宽度(按栅格化进行)并且对高度没有限制的容器称为一个标准横切 2.留白 两个容器或碎片之间的上、下、左、右的空白距离 3.继承

元素可以从其父级元素中获得一些可为自己使用的属性或值。4.图片定位

把图片元素放置到一个静态的、相对的、绝对的、或固定的位置中，利用CSS中对图片进行遮罩属性，多用于页面中的修饰图 5.底图

页面中在标签中使用的背景图 6.齐底(图)线 用于区分横切或碎片结束的线或图 7.页面结构

页面的基础框架，由横切、布局元素组成 8.焦点区(图)最易注意的区域 9.导航

在页面中具有导向性的链接集合 10.头图 页面主题图片 11.间距

碎片或文字间的距离 12.行高

文字段落中行与行之间的距离 13.首行缩进 文字段落首行缩进 14.浮动

使被定义的区域脱离正常的页面文档流 15.碎片 由文字、图片组合成的内容区域 16.通栏广告 与页面内容区同宽的广告区域 17.功能按钮 具有交互属性的按钮 18.私有样式

当前页面独立使用的样式，不具备公用性 19.水平(垂直)居中

在页面中的某个元素处于父级的上下或左右的相同距离 20.标准头(尾)定义相同的页面头或尾元素集合 二.文本格式化 1.段落：p 2.斜体：address（联系信息）em（强调）i（突出不同）cite（引用）dfn（首次定义术语）3.粗体：strong（重要）b（提醒）4.图片块：figure 5.引述文段，段落缩进：blockquote 6.背景颜色：mark 7.虚线下划线：abbr 8.上标下标：sub/sup 9.下划线：ins 10.删除线：del（标记已删除内容）s（标记不准确内容）11.等宽字体：code 12.预格式化：pre 13.字号减小，表注释：small 14.时间：time 15.换行：br 16.html5定义区块：header nav article section aside footer div span 三.表单表格

1.

...

2.表单元素的组织：

...

...

3.创建各种框: 注：text→password/url/tel/email Id:为了让对应的标签识别，添加CSS Name：为了让服务器和脚本识别，通常与id设为一样 Size：文本框大小 Maxlength：能输入的最大字符数 Pattern：正则表达式

4.添加标签： „ 5.单(多)选按钮：

北京 上海 注：id各自唯一，name必须相同。checked：默认选择 6.下拉框：

北京 上海 成都 注：size:选择框的高度 multiple：允许多选 selected：默认选择 用„对选择框进行分组 7.上传文件： 注：size：输入路径和文件名的字段的宽度 8.禁用表单元素： 9.创建提交按钮： 创建带图像的提交按钮：点击这里 创建图像按钮： Submit→reset重置

10.文本区域：请在此输入字符 11.表格 :

..	..
..	..	..

四.文本格式化 1.{font：（斜体 粗体 小型大写字母）字体大小(必有)行距 字体集（必有）;} 2.文本背景：{ background：#foc url（1.jpg）repeat-x scroll 0 0；} 3.字间距：word-spacing:12px;4.字偶距：letter-spacing:12px;5.缩进增加：text-indent:12px;6.小型大写字母: font-variant:small-caps;7.文本对齐：text-align:left；适用于block，inline-block 8.单词大小写: text-transform:capitalize(单词首字母大写)/uppercase(大写)/lowercase(小写)9.文本上的线：text-decoraion:underline/overline/line-through;11.空格：white-space:pre(显示所有空格回车)/nowrap（非断行空格）； 12.h3—16px;h5—12px;verdana,Geneva,sans-serif;13.列表属性： li{list-style:url(1.jpg)inside square;} 五.CSS布局

1.width：不包括padding，border，margin；max-width设置外围限制； 2.浮动：float:left;清除浮动：clear:both;3.设置边框： border:dotted 4px red;(dotted点状、dashed虚线、solid实线)4.使元素对齐：vertical-align:baseline/middle/text-bottom..5.显示：display:black/inline/inline-block;6.显示：visibility:visible/hiddle;7.相对定位：{position:relative;top:5px;} 相对于该元素的原始位置 8.绝对定位：{position:absolute;top:5px;} 相对于body或离他最近定位的祖先元素 9.三维位置：{z-index:50;} 越大的在最上面

10.厂商前缀：-webkit-(safari)–moz-(firefox)–ms-(IE)–o-(opera)11.创建圆角： {-moz-border-radius-topleft:50px;-webkit-border-top-left-radius:50px;border-top-left-radius:50px;}(左上角,角的半径是50px){border-radius:50px;}(所有角简写)12.创建椭圆角：{„ „ border-radius:40px/20px;}（x半径/y半径）13.创建圆形：{„ „ border-radius:50px;} 50px为元素半径大小 14.文本加阴影：{text-shadow: 2px 5px 5px #999;} x/y/模糊半径

15.元素加阴影：{(-moz-/-webkit-)box-shadow:(inset内阴影)2px 5px 5px #999;5px 10px 2px #555(多重阴影);} 16.多重背景：{background:#000 url(1.png)50% 102% no-repeat,#222 url(2.png)12px-150px repeat-x;} 17.透明度： {opacity:.5;} 0→1 透明→不透明

18.渐变背景：{background:linear-gradient(left,#000,#999);}(left ：渐变线沿逆时针方向转至水平线的角度)六.html5视频音频

1.html5支持3种视频：.ogg/.ogv.mp4/.m4v.webm 2.添加视频： 视频属性：src autoplay controls muted loop poster width height preload 3.为视频添加多个来源： 4.html5支持5中音频：.ogg.mp3.wav.aac.mp4 5.添加音频： 音频属性：src autoplay controls muted loop preload。多个来源同video。七.一些约定

我们结合常用的一些命名习惯，再结合CSS的实际应用，整理出一些较好的命名习惯。1.样式名称首字母统一为小写字母，不能为数字，下划线及特殊字符；

3.设置边框： border:dotted 4px red;(dotted点状、dashed虚线、solid实线)4.使元素对齐：vertical-align:baseline/middle/text-bottom..5.显示：display:black/inline/inline-block;6.显示：visibility:visible/hiddle;7.相对定位：{position:relative;top:5px;} 相对于该元素的原始位置 8.绝对定位：{position:absolute;top:5px;} 相对于body或离他最近定位的祖先元素 9.三维位置：{z-index:50;} 越大的在最上面

10.厂商前缀：-webkit-(safari)–moz-(firefox)–ms-(IE)–o-(opera)11.创建圆角： {-moz-border-radius-topleft:50px;-webkit-border-top-left-radius:50px;border-top-left-radius:50px;}(左上角,角的半径是50px){border-radius:50px;}(所有角简写)12.创建椭圆角：{„ „ border-radius:40px/20px;}（x半径/y半径）13.创建圆形：{„ „ border-radius:50px;} 50px为元素半径大小 14.文本加阴影：{text-shadow: 2px 5px 5px #999;} x/y/模糊半径

15.元素加阴影：{(-moz-/-webkit-)box-shadow:(inset内阴影)2px 5px 5px #999;5px 10px 2px #555(多重阴影);} 16.多重背景：{background:#000 url(1.png)50% 102% no-repeat,#222 url(2.png)12px-150px repeat-x;} 17.透明度： {opacity:.5;} 0→1 透明→不透明

18.渐变背景：{background:linear-gradient(left,#000,#999);}(left ：渐变线沿逆时针方向转至水平线的角度)六.html5视频音频

1.html5支持3种视频：.ogg/.ogv.mp4/.m4v.webm 2.添加视频： 视频属性：src autoplay controls muted loop poster width height preload 3.为视频添加多个来源： 4.html5支持5中音频：.ogg.mp3.wav.aac.mp4 5.添加音频： 音频属性：src autoplay controls muted loop preload。多个来源同video。七.一些约定

我们结合常用的一些命名习惯，再结合CSS的实际应用，整理出一些较好的命名习惯。1.样式名称首字母统一为小写字母，不能为数字，下划线及特殊字符； 2.样式名尽量语义化或简写； 3.样式名需要组合拼写时，采用全部小写拼写并使用下划线连接，即：all_keyword； 4.使用px(像素)为基本计量单位； 5.页面中空格的使用：全角：中文空格 半角；  6.项目完成包中，文件夹及文件名称全部采用小写字母，不使用中文文件名； 7.减少DIV的嵌套层数；

8.给重要图片加上alt属性；给重要的元素和截断的元素加上title； 9.使用正确的注释方法（详见“注释”章节）； 10.特殊情况下要求表现和内容分离，代码中不要涉及任何表现的元素，例如：style、font 等；

11.双标记签都要有开始和结束标签，单标记标签的后面一定要加“ /”,例如：
等，并且有正确的层次； 12.其它特殊符号： 1)<(<)2)>(>)八.命名空间

8.1外挂样式名称 全局：public.css 全局样式为全站公用，为页面样式基础，页面中必须包含。结构：layout.css 页面结构类型复杂，并且公用类型较多时使用。多用在首页级页面和产品类页面中。私有：style.css 独立页面所使用的样式文件，页面中必须包含。模块 module.css 产品类页面应用，将可复用类模块进行剥离后，可与其它样式配合使用。默认 default.css 文章 article.css 图片 photo.css 下载 soft.css 主题 themes.css 实现换肤功能时应用。补丁 mend.css 基于以上样式进行的私有化修补。8.2 常用名称(1)页面结构 容器: container 页头：header 内容：content/container/content(A)页面主体：main 页尾：footer 导航：nav 侧栏：sidebar 栏目：column 页面外围控制整体布局宽度：wrapper 左右中：left right center 浮左浮右：fl fr 清除浮动 clear(2)导航 导航：nav 主导航：mainbav 子导航：subnav 顶导航：topnav 边导航：sidebar 左导航：leftsidebar 右导航：rightsidebar 菜单：menu 子菜单：submenu 标题：title 摘要：summary 路径：path(3)模块化命名 模块头部：hd 模块内容部分：bd 模块底部：ft(4)各内容页对应 标题：title 副标题：subtitle 属性：properties 简介：infor 内容：content 分页：page 插入广告：insert_ad 表情：expression 功能选项：options 上下篇：up_down 评论：comments 相关内容：related 下载地址：download 播放地址：play_add(5)功能 标志：logo 广告：banner 登陆：login 登录条：loginbar 注册：regsiter 搜索：search 日期：date 功能区：shop 标题：title 加入：joinus 状态：status 按钮：btn 滚动：scroll 标签页：tab 文章列表：list 提示信息：msg 当前的：current 小技巧：tips 图标：icon 注释：note 指南：guild 服务：service 热点：hot 新闻：news 下载：download 投票：vote 合作伙伴：partner 友情链接：link 版权：copyright 九.基本设置-public.css 9.1 全局设置

上下边距(margin、padding)：0(px)左右边距(margin)：auto(自动)底色(background):#FFF(白色)字体(font-family)、字号(font-szie)、字色(color)：”宋体” 12px #666 代码： /* 全局CSS定义 */ body{margin:0 auto;padding:0;background:#FFF;color:#666;font:12px ‘宋体';} div,form,ul,ol,li,span,p,dl,dt,dd,img{margin:0;padding:0;border:0;} h1,h2,h3,h4,h5,h6{margin:0;padding:0;font-size:12px;font-weight:normal;} ul,ol,li{list-style:none} table,td,input,textarea{font-size:12px} 9.2 页面标签初始化设置 1.常用基本标div,form,ul,ol,li,span,p,dl,dt,dd,img 设置基本标签的间距、边框默认值为0。2.h1～h6标题

默认标题内字号12px，内外间距为0px，文字不加粗。3.ul,ol,li 列表 默认不显示项目符号。4.h2 栏目标题

说明：h2标签被定义为栏目标题特殊使用，在标签中非标题文字默认居右显示，主标题文字使用span标签包含，居左显示。5.默认链接颜色

常态下不显示文字下划线，颜色为灰(#333)，鼠标悬浮时：显示文字下划线，颜色变为暗红(#ccc)。6.状态：a:link{未点} a:visited{已点} a:focus{键盘选中} a:hover{指针停留} a:active{正在点} 9.3 页面宽度 默认页面宽(命名规范)：按栅格化进行 9.4.clear 结束容器内各元素的浮动属性，使相邻容器或元素节点正常显示。以下是清除浮动的几种方法 方法一.clear { clear:both;height:0;font-size:0;line-height:0 } 或.clear { border-top: 1px solid transparent!important;margin-top:-1px!important;border-top: 0px;margin-top: 0px;height: 0px;clear: both;background: none;font-size: 0px;visibility: hidden;} 或.clear{ clear:both;font-size:1px;width:1px;height:0;visibility:hidden;margin-top:0px!important;*margin-top:-1px;line-height:0 } 使用方法: