前端开发规范文档

文章目录

我的愿景

成为业内知名的web前端开发工程师

文档介绍

这份文档已经写了差不多一年了,最近也更新过了,作为一个有组织和纪律的团队,规范是必须的,毕竟每个coder都有自己的一套风格和规范,为了以后团队的和谐发展,结合前端业界的开发经验,故而写出了一个相对是大而简洁的文档,希望能够对你也有所启发。下面简要的摘录我的文档,详细的可以在本文底部下载PDF文档。

文件规范

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

HTML书写规范

  1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进;
  2. 非特殊情况下样式文件必须外链至<head></head>之间;非特殊情况下JavaScript文件必须外链至页面底部;
  3. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.7.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js;
  4. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合; 属性值必须用双引号包括;
  5. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等其他命名方式;
  6. 语义化html, 如 标题根据重要性用h(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;
  7. 尽可能减少div嵌套
  8. 书写链接地址时, 必须避免重定向,例如:href=”http://www.example.com/”, 即须在URL地址后面加上“/”;
  9. 在页面中尽量避免使用style属性,即style=”…”,应该尽量使用class或者id来定义新的样式,然后再对应的css文件里面修改;

CSS规范

  1. 编码统一为utf-8;
  2. 公用文件:协作开发过程中,会引入默认的base.css(里面包括了css reset、常用的css间距,css字体,css大小等,详细参见base.css);
  3. class与id命名: ,样式名称由 小写英文 、 数字 和 _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合;命名要语义化, 简明化。
  4. JavaScript预留钩子的命名, 尽量使用id属性,可以更快的获取到dom。
  5. css属性书写顺序, 建议遵循: 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: display 、 list-style 、 position(相应的 top,right,bottom,left) 、 float & clear 、 visibility 和 overflow; 自身属性主要包括: width 、height 、 margin 、 padding 、 border 和 background; 文本属性主要包括:color 、 font、 text-decoration 、 text-align 、 vertical-align 、 white- space 和其他content; 我所列出的这些属性只是最常用到的, 并不代表全部;
  6. 书写代码前, 考虑并提高样式重复使用率;
  7. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;
  8. 必须为大区块样式添加注释, 小区块适量注释;
  9. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化会统一处理;

JavaScript规范

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

图片规范

  1. 每个模块都会增加一个图片文件夹,方便后期维护和处理,请将同一个模块的图片放在同一个文件夹里面,图片文件命名尽量跟css文件的命名相同,尽量使用小写命名。
  2. 图片格式仅限于gif || png || jpg;
  3. 命名全部用小写英文字母 || 数字 || -(统一用分划线衔接) 的组合,其中不得包含汉字 || 空格 || 特殊字符;尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用分划线隔开, 比如ad-left01.gif || btn-submit.gif;
  4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;
  5. 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);
  6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求。

注释规范

  1. html注释: 注释格式 , 只能在注释的始末位置,不可置入注释文字区域;
  2. <!-- 头部 -->  <!-- //头部 -->包围,请务必要分开注释的文字(即注释文字中加空格)
  3. css注释: 注释格式 ;/**/
  4. JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 ;/**/

开发及测试工具约定

更多内容请参考PDF文档(下同)

其他规范

浏览器css hack

前端开发文档2.0

新版修改日志(2014-3-6)

  1. 修改了CSS hack的内容,增加了IE7、IE10和其他浏览器的hack属性,参考:CSS hack属性
  2. 增加了CSS代码书写顺序和CSS常用命名,参考:CSS代码书写顺序和命名
  3. 增加了一个工具集,参考:前端工具流:工具集
  4. 修改了“连字符CSS选择器命名规范”,改为“-”。原因如下:
    1. 输入的时候少按一个shift键;
    2. 浏览器兼容问题 (比如使用_tips的选择器命名,在IE6是无效的)
    3. 能良好区分JavaScript变量命名(JS变量命名是用“_”)
  5. 增加了CSS文件命名附录

文档说明

  1. 此篇文章参考了一些前辈的经验而写,只是为你提供了一个大体的思路,你可以下载,并根据自己的团队情况和协作环境制定具体内容,如果你有更好的意见,欢迎在这里留言;
  2. 本文档制作和内容编写归本站所有,任何人未经许可,不得在其他下载站点传播文档(比如百度文库),上传给其他人使用和下载,这是我用心在做的事,希望大家能够给我一点支持;
  3. 如果你觉得这篇文档对你有帮助,不妨支持一下我,在你的qq群告知你的好友或者公司项目中推广使用;
  4. 如果你想转载这篇文章,请链接到这篇文章,因为我可能随时会更新这里的内容。感谢各位前端同仁的支持。

下载文档

由于把gift专栏删掉,忘记删掉了这个文档说明,本文档已经不再对外提供,只给熟悉的朋友。请勿联系了,谢谢。

原文链接:(http://caibaojian.com/web-fontend-doc.html)
转发请注明来自前端开发博客
评论已关闭。

“前端开发规范文档”有66个评论

  1. 朵亚

    很不错的规范,学习~[呵呵]

    登录回复
  2. 朵亚

    zz

    登录回复
  3. djxin本人

    学习了的

    登录回复
  4. 路过_蜜蜂

    想看看

    登录回复
  5. cnxk

    我想下载

    登录回复
  6. 奶油贩子

    学习学习

    登录回复
  7. 一时发呆回不了神

    非常好,学习了

    登录回复
  8. 15money

    很不错的学习文档,谢谢博主

    登录回复
    • 15money

      PDF下载文档呢?博主为了骗注册还不给下,真不靠谱,丢站点的脸

      登录回复
      • 前端博客

        抱歉,真不是故意的,这个文档已经很久没更新了。礼品专栏被我删掉了,我忘记这里的了。 为了补偿,我发了一份给你的微博私信了,希望你看完后不要嫌弃我的文档写得太烂。[抱拳]

        登录回复
        • edwarhvv
          回复前端博客 :

          博主能不能给我也发一份呀!很想想你学习学习

          登录回复