• 图片规范、注释规范、测试工具约定


    图片规范:

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

    注释规范:

    • JAVASCRIPT、CSS文件注释需要标明作者、文件版本、创建/修改时间、重大版本修改记录、函数描述、文件版本、创建或者修改时间、功能、作者等信息。
    /* * 注释块 */

    中间可添加如下信息。

    @file 文件名
    @addon 把一个函数标记为另一个函数的扩张,另一个函数的定义不在源文件中
    @argument 用大括号中的自变量类型描述一个自变量
    @author 函数/类作者的姓名
    @base 如果类是继承得来,定义提供的类名称
    @class 用来给一个类提供描述,不能用于构造器的文档中
    @constructor 描述一个类的构造器
    @deprecated 表示函数/类已被忽略
    @exception 描述函数/类产生的一个错误
    @exec @extends 表示派生出当前类的另一个类
    @fileoverview 表示文档块将用于描述当前文件,这个标签应该放在其它任何标签之前
    @final 指出函数/类
    @ignore jsdoc忽视随后的代码
    @link 类似于@link标签,用于连接许多其它页面
    @member 定义随后的函数为提供的类名称的一个成员
    @param 用大括号中的参数类型描述一个参数
    @private 表示函数/类为私有,不应包含在生成的文档中
    @requires 表示需要另一个函数/类
    @return 描述一个函数的返回值
    @see 连接到另一个函数/类
    @throws 描述函数/类可能产生的错误
    @type 指定函数/成员的返回类型
    @version 函数/类的版本号

    开发及测试工具约定:

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

    收集整理了这些开发规范,感谢所有的原作者。

  • 相关阅读:
    eclipse生成jar包 注意事项!
    java结合testng,利用XML做数据源的数据驱动示例
    2018 计蒜之道 初赛 第二场
    2018 计蒜之道 初赛 第一场
    Tarjan&&缩点简析
    POJ1159
    POJ1080
    POJ1260
    POJ2533&&1836&&3176
    Luogu P1484 种树
  • 原文地址:https://www.cnblogs.com/hubl/p/5743783.html
Copyright © 2020-2023  润新知