软件开发流程规范.doc

软
件
开
发
流
程
规
范

德联软件有限责任公司
编制人: 侯秀美审核人:
2015 年 8 月 19 日
目录
目录 0
一、概述 2
二、开发流程规范 3
系统软硬件开发环境 3
系统架构(系统组成) 5
系统功能模块设计 6
系统功能开发流程图 6
开发修改记录 7
三、开发代码规范 8
文件结构 8
文件信息声明 8
头文件的结构 10
定义文件的结构 11
头文件的作用 12
目录结构 13
命名规则 13
共性原则 13
Windows变量命名规则 14
程序风格 16
空行 17
代码行 18
代码行内的空格 19
对齐 20
长行拆分 22
修饰符的位置 23
注释 23
函数设计 26
参数的规则 26
返回值的规则 27
函数内部实现的规则 30
其它建议 32
使用断言 32
引用与指针的比较 33
变量类型定义 35
四、软件测试规范 36
单元测试 36
系统测试 37
业务测试 38
验收测试 38
用户现场测试 38
五、软件版本管理 39
39
一、概述
本文制定烟台开发区德联软件有限责任公司计算机软件开发规范文档。本规范的目的是使公司软件开发项目阶段清晰、要求明确、任务具体、编写的代码规范,使之规范化、系统化和工程化,向公司内从事软件开发的工程师和管理人员提出一系列规范和要求,从而有利于开发过程的控制和管理,提高所开发软件系统的质量,缩短开发时间,减少开发和维护费用,以保证项目高质量、顺利进行。
本规范包含:开发流程规范和开发代码规范等,开发流程规范需要技术开发人员编写相关内容,希望每个技术人员形成习惯,如有新的内容更新会及时通知大家,如有好的规范要求也可通知编制人员及时更新。
本规范为烟台开发区德联软件有限责任公司内部材料,严禁其他商业应用。
二、开发流程规范
接受开发任务,详细阅读软件技术规范或技术文档,如对技术文档有疑义或者不清楚的地方及时与项目总工或用户沟通,根据文档和沟通内容编写项目开发计划,必须包括但不限于系统软硬件开发环境、系统架构、系统功能模块设计、系统功能开发流程图、开发修改记录。
系统软硬件开发环境
开发环境的搭建,最好形成文档,便于以后同样工作的使用。开发人员要明确系统开发拟采用的数据库、操作系统、开发语言、开发工具、服务器等(具体到版本)。明确整个系统开发工作流程,至少应该包括以下流程。
系统架构(系统组成)
确定系统整体体系架构,各层次之间的数据流的连接,确定软件服务器的硬件配置及用户硬件资源配置, 确定与用户软件平台的统一协调。开发人员在绘制架构图时给出基本框架,能反映出基本意义即可,可以直接用文字代替例子中的图片。
图1 系统逻辑架构图举例
图2 物理架构图举例
系统功能模块设计
给出系统的主要功能模块,每个模块所包含的功能。
图3 图书管理系统模块规划图举例
系统功能开发流程图
给出系统主要功能的业务流程图。
图4 系统功能业务流程图举例
开发修改记录
1. 开发代码做好备份(可以在完成一个重大功能之后,或者按时间周期性进行备份),以免由于不可抗力导致代码不可修复。
(改动的具体细节),修改前的版本要及时备份,可以方面随时还原系统。
修改日期
修改内容
是否备份
备注
三、开发代码规范
在研究项目团队协作开发的情况下(这里的团队协作也适合于应用项目的开发),编程时应该强调的一个重要方面是程序的易读性,在保证软件速度等性能指标能满足用户需求的情况下,能让其他程序员容易读懂你所编写的程序。若研究项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格,可以让协作者、后继者和自己一目了然,在很短的时间内看清楚程序结构,理解设计的思路,大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性。
制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性,提高软件的质量。本规范由程序风格、命名规范、注释规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。
此规范以C/C++程序设计讨论。
文件结构