WEB 前端开发规范文档
前言:前端开发过程中, 无论是团队开发, 还是单兵做站, 有一份开发文档做规范, 对开发工
作都是很有益的. 软件的长期价值直接源于其编码质量.在它的整个生命周期里,一个程序
可能会被许多人阅读或修改. 如果一个程序可以清晰的展现出它的结构和特征,那就能减
少在以后对其进行修改时出错的可能性. 编程规范可以帮助程序员们增加程序的健壮性. 所
有的 Html,JavaScript,Css 代码都是暴露给公众的.所以我们更应该保证其质量.保持整
洁很重要。
规范目的
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的代码, 特
制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本
文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.
基本准则
符合 web 标准, 语义化 html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简
洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.
文件规范
1. html, css, js, images 文件均归档至<系统开发规范>约定的目录中;
2. html 文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名
为中文, 请重命名与 htm 文件同名, 以方便后端添加功能时查找对应页面;
3. css 文件命名: 英文命名, 后缀.css. 共用 base.css, 首页 index.css, 其他页面依实际模
块需求命名.;
4. JS 文件命名: 英文命名, 后缀.js. 共用 common.js, 其他依实际模块需求命名.
html 书写规范
1. 文档类型声明及编码: 统一为 html5 声明类型<!DOCTYPE html>; 编码统一为
<meta charset=”utf-8” />, 书写时利用 IDE 实现层次分明的缩进;
2. 非特殊情况下样式文件必须外链至<head>…</head>之间;非特殊情况下
JavaScript 文件必须外链至页面底部,并按照使用顺序排列,cs 文件顺序不同最终效果效
果也不一样,样式表对于同一个样式名称或同一样式遵循后来居上的特性(最近最后呈现
效果优先级为:行内>外部样式[如果有多个且相同样式已最后引入的为准])可能由于网
络原因导致最后呈现问题,js 文件引用组件或库的先载入库或其他依赖文件;
3. 引入样式文件或 JavaScript 文件时, 须略去默认类型声明, 写法如下:
<link rel=”stylesheet” href=”…” />
<style>…</style>