Web前端开发规范概要.doc

Web前端开发规范 规范概述 目的 为提高团队协作效率，便于后台人员添加功能及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后方可更改。 准则 符合web标准，语义化html，结构表现行为分离，兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 文件规范 基本要求 对页面中标签属性的值都需要用双引号包括起来 所有页面编码均采用utf-8 文件存放与命名规范 html，css，js，images文件均归档至《系统开发规范》约定的目录中； html文件命名：英文命名，后缀.htm，同时将对应界面稿放于同目录中, 并要求与html文件同名，以方便后端添加功能时查找对应页面； css文件命名：英文命名，后缀.css，共用base.css，首页index.css，其他页面依实际模块需求命名； js文件命名：英文命名，后缀.js，共用common.js，其他依实际模块需求命名。 html书写规范 文档类型声明及编码：统一为html5声明类型!DOCTYPE html；编码统一为meta charset=utf-8 /，书写时利用IDE实现层次分明的缩进； 非特殊情况下样式文件必须外链至head.../head之间；非特殊情况下JavaScript文件必须外链至页面底部； 引入样式文件或JavaScript文件时，须略去默认类型声明，写法如下： link rel=stylesheet href=... / style.../style script src=.../script 引入JS库文件，路径或文件名须包含库名称及版本号及是否为压缩版，比如jquery-1.4.1.min.js；引入插件，文件名格式为库名称+插件名称，比如jQuery.cookie.js； 所有编码均遵循xhtml标准，标签、属性、属性命名必须由小写字母及下划线数字组成，且所有标签必须闭合，包括 br (br /), hr(hr /)等；属性值必须用双引号包括； 充分利用无兼容性问题的html自身标签，比如span、em、strong、optgroup、 label，等等；需要为html元素添加自定义属性的时候，首先要考虑下有没有默认的已有的合适标签去设置，如果没有，可以使用须以data-为前缀来添加自定义属性，避免使用data:等其他命名方式； 语义化html，如标题根据重要性用h*(同一页面只能有一个h1)，段落标记用p，列表用ul，内联元素中不可嵌套块级元素； 尽可能减少div嵌套，如： div class=box div class=welcome欢迎访问XXX，您的用户名是 div class=name用户名/div /div /div 完全可以用以下代码替代： div class=box p欢迎访问XXX, 您的用户名是span用户名/span/p /div 书写链接地址时，必须避免重定向，例如：href=/，即须在URL地址后面加上“/”； 在页面中尽量避免使用style属性,即style=…； 必须为含有描述性表单元素(input，textarea)添加label，如： p姓 名: input type=text id=name name=name //p 须写成： p label for=name姓 名: /label input type=text id=name / /p 能以背景形式呈现的图片，尽量写入css样式中； 重要图片必须加上alt属性，重要的元素和截断的元素加上title； 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能； 特殊符号使用：尽可能使用代码替代: 比如 (lt)、(gt;)、空格(nbsp;)等等； class和id 参见 css书写规范。 css书写规范 编码统一为utf-8； CSS的命名 　　外套:wrap 　　主导航:mainNav 　　子导航:subnav 　　页脚:footer 　　整个页面:content 　　页眉:header 　　页脚:footer 　　商标:label 　　标题:title 　　主导航:mainNav(globalNav) 　　顶导航:topnav 　　边导航:sidebar 　　左导航:leftsideBar 　　右导航:rightsideBar 　　旗志:logo 　　标语:banner 　　菜单内容1:menu1Content 　　菜单容量:menuContainer 　　子菜单:submenu 　　边导航图标:sidebarIcon 　　注释:note 　　面包