Web前端开发规档

2020-03-02 07:24:04 来源：范文大全收藏下载本文

无论是从技术角度还是开发视角，对于web前端开发规范文档都有一定规范，本文就c3和html5的发展前景总结了一系列的web开发文档，仅供大家参考。

规范目的

为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档.本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发.本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.

基本准则

符合web标准, 语义化html, 结构表现行为分离, 兼容性优良.页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.

文件规范

1.html, c, js, images文件均归档至约定的目录中;

2.html文件命名: 英文命名, 后缀.htm.同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;

3.c文件命名: 英文命名, 后缀.c.共用base.c, 首页index.c, 其他页面依实际模块需求命名.;

4.Js文件命名: 英文命名, 后缀.js.共用common.js, 其他依实际模块需求命名.

html书写规范

1.文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进;

2.非特殊情况下样式文件必须外链至„之间;非特殊情况下JavaScript文件必须外链至页面底部;

3.引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下:

…

4.引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js;

5.所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (), hr()等; 属性值必须用双引号包括;

6.充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性，避免使用”data:”等其他命名方式;

7.语义化html, 如标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;

8.尽可能减少div嵌套, 如欢迎访问XXX, 您的用户名是用户名完全可以用以下代码替代:

欢迎访问XXX, 您的用户名是用户名

;

9.书写链接地址时, 必须避免重定向，例如：href=”http://itaolun.com/注释: 注释格式 , ’–’只能在注释的始末位置,不可置入注释文字区域;

2.c注释: 注释格式 /*这儿是注释*/;

3.JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 /* 这儿有多行注释 */;

开发及测试工具约定

建议使用Aptana || Dw || Vim , 亦可根据自己喜好选择, 但须遵循如下原则:

1.不可利用IDE的视图模式’画’代码;

2.不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;

3.编码必须格式化, 比如缩进;