软件开发规范 v0.1.docVIP

软件开发规范 v0.1 吴振亨@2002年12月25日 1 前言 为了使软件开发过程有章可循，保证软件质量，加强开发管理。 2 开发管理 项目进度周报表格如下： 项目编号： 汇报人： 汇报日期： 项目进度详细描述： 其他问题： 3 项目周期 司项目开发周期分为以下几个步骤： 步骤 说明 参与角色 生成文档或程序（打*号为可选） 可行性分析 对项目的技术，功能需求和市场进行调研和初步分析，确定是否需要立项开发。 部门主管核心技术员 可行性分析报告*技术调研报告* 立项 正式立项，由部门主管指定项目经理，项目经理制定初步计划。初步计划包括设计和开发时间的初步估算。 部门主管核心技术员 项目初步计划 需求分析 对项目进行详细的需求分析，编写需求分析文档。对于B/S结构软件系统需要制作静态演示页面。需求分析文档和静态演示页面需要通过部门主管审批才能够进行到下一个步骤 项目经理项目核心小组 需求分析文档静态演示页面项目计划修订版本 详细设计 根据需求分析对项目进行详细设计。详细设计以后，项目经理同部门主管一起指定项目小组开发成员。 项目经理项目核心小组 详细设计文档项目计划确定版本 开发 根据设计开发项目，由美工对操作界面进行美化。 项目经理项目开发员美工 项目计划修订版本* 测试 项目经理提交测试申请，由测试部门对项目进行测试。项目小组配合测试部门修改软件中的错误。 项目经理项目开发员测试部 测试申请测试计划测试报告 项目验收 项目验收归档 部门主管项目经理 项目所有文档和程序 4 命名规范 4.1 项目编号命名规范 待完善 4.2 文档命名规范 待完善 4.3 jsp/html命名规范 jsp与html文件名全部小写，并遵循如下的规范： u 数据/内容显示页 名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上 “_list”。例如： new_message.html 或 my_file_list.jsp u 操作处理页 命名格式：名词_下划线_动词，例如：file_delete.jsp。 u 含frame页面 frameset中frame的name属性命名的格式是①xxx._②xxx_③xxx ①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。 如：属于ebwebmail则被表示为ebwebmail，其它情况依次类推。 ②xxx部分标识当前页面所要完成的功能。 如：完成用户登录的功能则被标识为login，其它情况依次类推。 ③xxx部分用来用来表示页面在浏览器窗口所处的位置。 处于浏览器窗口的顶部则标识为top，其它情况依次类推。 例如：ebwebmail_inbox_top.jsp frame src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。 u javascript脚本方法 脚本函数都以①xxx_②xxx的方式命名。 ①xxx对应页面隶属的模块。 ②xxx表示函数所要实现的功能(动宾结构)，多个单词用下划线连接。 例如：ebwebmail_send_mail() 模块通用的脚本函数必须集合于一个js文件中，在页面上通过script language=”javascript” src=”url”/script形式导入。js文件名命名使用模块名，例如：ebwebmail.js。 如果项目已经提供了公共js脚本，则优先使用公共js脚本中提供的函数。 所有定义方法的script元素定义在head/head中或/body后。 u javascript脚本内部变量与参数 单词之间用下划线分隔且全部小写，例如： var file_size。 u form表单name属性 统一以“form_”开头，其后加该表单所需收集的信息的作用或动作，例如：form_file_upload 或 form_send_mail。 u 表单elements 表单element的名称以element需收集的信息标示命名，单词之间使用下划线分隔且全部小写，例如： input type=”text” name=”username” input type=”radio” name=”file_type” textarea name=”content” rows=”5” cols=”40” u cookie命名 命名格式：模块名_存储信息名词(多个单词用下划线分隔) ，全部大写，例如：EBWEBMAIL_SORT_TYPE。 u window.open中name参数的命名 javascript的window.open方法中有一个name的参数，浏览器约定同样的名字的窗口只能打开一个，如果程序