web前端开发的规范

web前端开发的规范

 

一、web前端开发的规范

 

文件规范 

 

1. html, css, js, images文件均归档至<系统开发规范>约定的目录中; 

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

 

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

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

 

 

html书写规范 

 

1. 非特殊情况下样式文件必须外链至<head>...</head>之间;非特殊情况下JavaScript文件必须外链至页面底部;   

 

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

 

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

 

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

 

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

6. 尽可能减少li嵌套, 

<li class="box"><li class="welcome">欢迎访问XXX, 您的用户名是<li class="name">用户名</li></li></li>

完全可以用以下代码替代: 

<li class="box"><p>欢迎访问XXX, 您的用户名是<span>用户名</span></p></li>;

 

7. 在页面中尽量避免使用style属性,即style="…"

8. 能以背景形式呈现的图片, 尽量写入css样式中;

9. 重要图片必须加上alt属性给重要的元素和截断的元素加上title;

10. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;

 

11. 特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(&gt;) & 空格( ) & »(») 等等;

12. 书写页面过程中, 请考虑向后扩展性;

13. class & id 参见 css书写规范.

 

 

 

css书写规范

 

1. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由我分发框架文件时命名的, 为JavaScript预留钩子的除外;

 

2. css属性书写顺序, 建议遵循 布局定位属性-->自身属性-->文本属性-->其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 

 

3. 书写代码前, 考虑并提高样式重复使用率;

4. 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;

5. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;

 

6. 必须为大区块样式添加注释, 小区块适量注释;

7. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化i会统一处理;

 

 

JavaScript书写规范

 

1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || ...);

 

2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;

 

3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun; jQuery变量要求首字符为'_', 其他与原生JavaScript 规则相同, 如: _iTaoLun; 另, 要求变量集中声明, 避免全局变量.

 

4. 类命名: 首字母大写, 驼峰式命名. 如 ITaoLun; 

5. 函数命名: 首字母小写驼峰式命名. 如iTaoLun();

 

6. 命名语义化, 尽可能利用英文单词或其缩写;

7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;

8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;

 

9. 代码结构明了, 加适量注释. 提高函数重用率;

10. 注重与html分离, 减小reflow, 注重性能. 

 

 

图片规范

 

1. 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;  

2. 图片格式仅限于gif || png || jpg;

 

3. 命名全部用小写英文字母 || 数字 || _ 的组合,其中不得包含汉字 || 空格 || 特殊字符;尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01。gif || btn_submit。gif; 

 

4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;

5. 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);

 

6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.

 

 

注释规范

 

1. html注释: 注释格式 <!--这儿是注释-->, '--'只能在注释的始末位置,不可置入注释文字区域; 

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

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

 

 

 

二、移动开发规范

 

 

1、字体设置

 

使用无衬线字体

 

  • body {
  •     font-family: "Helvetica Neue", Helvetica, STHeiTi, sans-serif;
  • }
  •  

     

    2、基础交互

     

    设置全局的CSS样式,避免长按弹出菜单与选中文本的行为

     

  • a, img {
  •     -webkit-touch-callout: none; /* 禁止长按链接与图片弹出菜单 */
  • }
  • html, body {
  •     -webkit-user-select: none;   /* 禁止选中文本(如无文本选中需求,此为必选项) */
  •     user-select: none;
  • }
  •  
  •  
  • 3、移动性能
  •  
  • 要考虑Android低端机与2G网络场景下性能


    (1)、发布前必要检查项

     

    所有图片必须有进行过压缩

    考虑适度的有损压缩,如转化为80%质量的jpg图片

    考虑把大图切成多张小图,常见在banner图过大的场景

     

    (2)、加载性能优化, 达到打开足够快

    数据离线化,考虑将数据缓存在 localStorage

    初始请求资源数 < 4

    图片使用CSS Sprites 或 DATAURI

    外链 CSS 中避免 @import 引入

    考虑内嵌小型的静态资源内容

    初始请求资源gzip后总体积 < 50kb

    静态资源(HTML/CSS/JS/IMAGE)是否优化压缩?

    避免打包大型类库

    确保接入层已开启Gzip压缩

    尽量使用CSS3代替图片

    初始首屏之外的图片资源需延迟加载

    单页面应用(SPA)考虑延迟加载非首屏业务模块

     

    (3)、运行性能优化, 达到操作足够流畅

    避免 iOS 300+ms 点击延时问题

    缓存 DOM 选择与计算

    避免触发页面重绘的操作

    Debounce连续触发的事件(scroll/resize),避免高频繁触发执行

    尽可能使用事件代理,避免批量绑定事件

    使用CSS3动画代替JS动画

    避免在低端机上使用大量CSS3渐变阴影效果,可考虑降级效果来提升流畅度

    HTML结构层级保持足够简单,推荐不超过 5 个层级

    尽能少的使用CSS高级选择器与通配选择器

    Keep it simple

     

    (4)、在线性能检测评定工具使用指南

    访问 Google PageSpeed 在线评定网站

    在地址栏输入目标URL地址,点击分析按钮开始检测

    按 PageSpeed 分析出的建议进行优化,优先解决红色类别的问题

    标签: