前端开发规范文档.docx

规范目的 为提高团队协作效率,?便于后台人员添加功能及前端后期优化维护,?输出高质量的文档,?特制订此文档.?本规范文档一经确认,?前端开发人员必须按本文档规范进行前台页面开发.?本文档如有不对或者不合适的地方请及时提出,?经讨论决定后方可更改. ? 基本准则 符合web标准,?语义化html,?结构表现行为分离,?兼容性优良.?页面性能方面,?代码要求简洁明了有序,?尽可能的减小服务器负载,?保证最快的解析速度. ? 文件规范 1. html, css, js, images文件均归档至系统开发规范约定的目录中; 2. html文件命名:?英文命名,?后缀.htm.?同时将对应界面稿放于同目录中,?若界面稿命名为中文,?请重命名与html文件同名,?以方便后端添加功能时查找对应页面; 3. css文件命名:?英文命名,?后缀.css.?共用base.css,?首页index.css,?其他页面依实际模块需求命名.; 4. Js文件命名:?英文命名,?后缀.js.?共用common.js,?其他依实际模块需求命名. ? html书写规范 1.?文档类型声明及编码:?统一为html5声明类型!DOCTYPE html;?编码统一为meta charset=gbk?/,?书写时利用IDE实现层次分明的缩进; 2.?非特殊情况下样式文件必须外链至head.../head之间;非特殊情况下JavaScript文件必须外链至页面底部; 3.?引入样式文件或JavaScript文件时,?须略去默认类型声明,?写法如下: link rel=stylesheet href=...?/ style.../style script src=.../script 4.?引入JS库文件,?文件名须包含库名称及版本号及是否为压缩版,?比如jquery-1.4.1.min.js;?引入插件,?文件名格式为库名称+插件名称,?比如jQuery.cookie.js; 5.?所有编码均遵循xhtml标准,?标签??属性??属性命名?必须由小写字母及下划线数字组成,?且所有标签必须闭合,?包括 br (br?/), hr(hr /)等;?属性值必须用双引号包括; 6.?充分利用无兼容性问题的html自身标签,?比如span, em, strong, optgroup, label,等等;?需要为html元素添加自定义属性的时候,?首先要考虑下有没有默认的已有的合适标签去设置,?如果没有,?可以使用须以data-为前缀来添加自定义属性，避免使用data:等其他命名方式; 7.?语义化html,?如?标题根据重要性用h*(同一页面只能有一个h1),?段落标记用p,?列表用ul,?内联元素中不可嵌套块级元素; 8.?尽可能减少div嵌套,?如div class=boxdiv class=welcome欢迎访问XXX,?您的用户名是div class=name用户名/div/div/div完全可以用以下代码替代:?div class=boxp欢迎访问XXX,?您的用户名是span用户名/span/p/div; 9.?书写链接地址时,?必须避免重定向，例如：href=/,?即须在URL地址后面加上“/”； 10.?在页面中尽量避免使用style属性,即style=…; 11.?必须为含有描述性表单元素(input, textarea)添加label,?如p姓名:?input type=text id=name name=name?//p须写成:plabel for=name姓名:?/labelinput type=text id=name?//p 12.?能以背景形式呈现的图片,?尽量写入css样式中; 13.?重要图片必须加上alt属性;?给重要的元素和截断的元素加上title; 14.?给区块代码及重要功能(比如循环)加上注释,?方便后台添加功能; 15.?特殊符号使用:?尽可能使用代码替代:?比如?()??(gt;)??空格(?)???(?)?等等; 16.?书写页面过程中,?请考虑向后扩展性; 17. class id 参见 css书写规范. ? css书写规范 1.?编码统一为utf-8; 2.?协作开发及分工: i会根据各个模块,?同时根据页面相似程序,?事先写好大体框架文件,?分配给前端人员实现内部结构表现行为;?共用css文件base.css由i书写,?协作开发过程中,?每个页面请务必都要引入,?此文件包含reset及头部底部样式,?此文件不可随意修改; 3. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的,?所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由我分发框架文件时命名