文档介绍：Web前端开发规范
应用指南
郑州蜂鸟科技有限公司周源
郑州软件开发兴趣小组群:
目录
一、 规范目的 3
概述 3
二、 文件规范 3
基本准则 3
文件规范 3
html书写规范 3
css书写规范 4
JavaScript书写规范 6
图片规范 6
注释规范 6
开发及测试工具约定 7
其他规范 7
三、 文档说明 7
规范目的
概述
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论后决定可以更改此文档.
文件规范
基本准则
符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度
文件规范
html, css, js, images文件均归档至<系统开发规范>约定的目录中;.
html文件命名: 英文命名, . 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;
css文件命名: 英文命名, . , , 其他页面依实际模块需求命名.
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-
; 引入插件, 文件名格式为库名称+插件名称, ;
所有编码均遵循xhtml标准, 标签& 属性& 属性命名必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (<br />), hr(<hr />)等; 属性值必须用双引号包括;
充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以"data-"为前缀来添加自定义属性,避免使用"data:"等其他命名方式;
语义化html, 如标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul