通用规范:


  • TAB键用两个空格代替(WINDOWS下TAB键占四个空格,LINUX下TAB键占八个空格)。
  • CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。
  • 文件内容编码均统一为UTF-8
  • CSSJAVASCRIPT中的非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示。

文件规范:


  • 文件名用英文单词,多个单词用驼峰命名法。
  • 一些浏览器会将含有这些词的作为广告拦截,文件命名、ID、CLASS等所有命名避免以上词汇。 adadsadvbannersponsorggguanggguanggao等。

图片规范:


  • 命名应用小写英文数字_组合,便于团队其他成员理解。
  1. header_btn.gif
  2. header_btn2.gif
  • 页面元素类图片均放入img文件夹,测试用图片放于img/testimg文件夹,psd源图放入img/psdimg文件夹。
  • 图片格式仅限于gifpngjpg等。
  • png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果,请为ie-6单独定义背景,并尽量避免使用半透明的png图片。
  • 背景图片请尽可能使用sprite技术, 减小http请求。

注释规范:


  • JAVASCRIPTCSS文件注释需要标明作者、文件版本、创建/修改时间、重大版本修改记录、函数描述、文件版本、创建或者修改时间、功能、作者等信息。
  1. /* * 注释块 */
  1. 中间可添加如下信息。
  1. @file 文件名
  2. @addon 把一个函数标记为另一个函数的扩张,另一个函数的定义不在源文件中
  3. @argument 用大括号中的自变量类型描述一个自变量
  4. @author 函数/类作者的姓名
  5. @base 如果类是继承得来,定义提供的类名称
  6. @class 用来给一个类提供描述,不能用于构造器的文档中
  7. @constructor 描述一个类的构造器
  8. @deprecated 表示函数/类已被忽略
  9. @exception 描述函数/类产生的一个错误
  10. @exec @extends 表示派生出当前类的另一个类
  11. @fileoverview 表示文档块将用于描述当前文件,这个标签应该放在其它任何标签之前
  12. @final 指出函数/类
  13. @ignore jsdoc忽视随后的代码
  14. @link 类似于@link标签,用于连接许多其它页面
  15. @member 定义随后的函数为提供的类名称的一个成员
  16. @param 用大括号中的参数类型描述一个参数
  17. @private 表示函数/类为私有,不应包含在生成的文档中
  18. @requires 表示需要另一个函数/类
  19. @return 描述一个函数的返回值
  20. @see 连接到另一个函数/类
  21. @throws 描述函数/类可能产生的错误
  22. @type 指定函数/成员的返回类型
  23. @version 函数/类的版本号

开发及测试工具约定:


  • 编码格式化,三码统一。
  • 测试工具: 前期开发仅测试FireFox & IE9以上& Opera & Chrome & Safari