【开发规范】前端技术开发规范

最新推荐文章于 2022-06-02 15:58:05 发布

墨城之左

最新推荐文章于 2022-06-02 15:58:05 发布

阅读量235

点赞数

分类专栏：开发规范文章标签：前端规范

开发规范专栏收录该内容

1 篇文章 0 订阅

订阅专栏

WEB前端开发规范文档

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

一规范目的

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

提升团队凝聚力，统一团队代码风格，优化团队协作效率！

二基本准则

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

结构分明、兼容性高、页面性能高、代码简洁明了。

三文件规范

3.1 命名规范

html, css, js, images 文件均归档至 <系统开发规范> 约定的目录中;
html 文件命名: 英文命名, 后缀 .htm; 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与 html 文件同名, 以方便后端添加功能时查找对应页面;
css 文件命名: 英文命名, 后缀 .css, 共用 base.css, 首页 index.css, 其他页面依实际模块需求命名.;
Js 文件命名: 英文命名, 后缀 .js. 共用 common.js, 其他依实际模块需求命名;

3.2 html 书写规范

文档类型声明及编码: 统一为 html5 声明类型 ; 编码统一为 , 书写时利用 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=”http://itaolun.com/”, 即须在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;
给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;
特殊符号使用: 尽可能使用代码替代;
书写页面过程中, 请考虑向后扩展性;

3.3 css书写规范

编码统一为 utf-8;
协作开发及分工: 根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构/表现/行为; 共用 css 文件 base.css 共同维护, 协作开发过程中, 每个页面请务必都要引入, 此文件包含 reset 及头部底部样式, 此文件不可随意修改;
class 与 id 的使用: id 是唯一的并是父级的, class是可以重复的并是子级的, 所以 id 仅使用在大的模块上, class 可用在重复使用率高及子级中; id 原则上都是在开发框架文件时命名, 为 JavaScript 预留钩子的除外;
为 JavaScript 预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show;
class 与 id命名: 大的框架命名比如 header/footer/wrapper/left/right 要统一命名. 其他样式名称由 小写英文/数字/_ 来组合命名, 如 i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.
规避 class 与 id 命名的方法:
- 通过从属写法规避
- 取父级元素id/class命名部分命名, 示例见d
- 重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear;
- 前两条, 适用于在 2 中已建好框架的页面, 如，要在已建好框架的页面代码<div id=”mainnav”></div>中加入新的div元素,
  1. <div id=”mainnav”><div class=”firstnav”>…</div></div>, 样式写法: #mainnav .firstnav{…….}
  2. <div id=”mainnav”><div class=”main_firstnav”>…</div></div>, 样式写法: .main_firstnav{…….}
css 属性书写顺序, 建议遵循 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起.
- 布局定位属性主要包括: margin/adding/float/position(相应的top,right,bottom,left)/display/visibility/overflow 等；自身属性主要包括: width/height/background/border;
- 文本属性主要包括：font/color/text-align/text-decoration/text-indent等；
- 其他属性包括: list-style(列表样式)/vertical-vlign/cursor/z-index(层叠顺序)/zoom等. 所列出的这些属性只是最常用到的, 并不代表全部;
书写代码前, 考虑并提高样式重复使用率;

充分利用 html 自身属性及样式继承原理减少代码量, 比如:

<ul class=”list”><li>这儿是标题列表<span>2010-09-15</span></ul>

定义为：

ul.list li{position:relative}  
ul.list li span{position:absolute; right:0}

即可实现日期居右显示

样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;
减少使用影响性能的属性, 比如position:absolute || float ;
必须为大区块样式添加注释, 小区块适量注释;
代码缩进与格式: 建议单行书写, 可根据自身习惯;

3.4 JavaScript 书写规范

文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据项目需求原生开发, 以避免网上 down 下来的代码造成的代码污染;
库引入: 须与团队其他人员讨论决定;
变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun; jQuery变量要求首字符为’_’, 其他与原生 JavaScript 规则相同, 如: _iTaoLun; 另, 要求变量集中声明, 避免全局变量.
类命名: 首字母大写, 驼峰式命名. 如 ITaoLun;
函数命名: 首字母小写驼峰式命名. 如 iTaoLun();
命名语义化, 尽可能利用英文单词或其缩写;
尽量避免使用存在兼容性及消耗资源的方法或属性, 比如 eval() & innerText;
后期优化中, JavaScript 非注释类中文字符须转换成 unicode 编码使用, 以避免编码错误时乱码显示;
代码结构明了, 加适量注释. 提高函数重用率;
注重与html分离, 减小reflow, 注重性能.

3.5 图片规范

所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;
图片格式仅限于gif || png || jpg;
命名全部用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如 ad_left01.gif || btn_submit.gif;
在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;
尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);
运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.

3.6 注释规范

html注释: 注释格式 <!–这儿是注释–>, ’–’只能在注释的始末位置, 不可置入注释文字区域;
css注释: 注释格式 /*这儿是注释*/;
JavaScript注释, 单行注释使用//这儿是单行注释 ,多行注释使用 /* 这儿有多行注释 */;

3.7 其他规范

开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;
减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.

墨城之左

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
【开发规范】前端技术开发规范

WEB前端开发规范文档无论是从技术角度还是开发视角，对于web前端开发规范文档都有一定规范，本文就css3和html5的发展前景总结了一系列的web开发文档，仅供大家参考。一规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档。本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出...
复制链接

扫一扫