软件开发流程规范.doc
- 文档编号:393046
- 上传时间:2022-10-09
- 格式:DOC
- 页数:42
- 大小:647KB
软件开发流程规范.doc
《软件开发流程规范.doc》由会员分享,可在线阅读,更多相关《软件开发流程规范.doc(42页珍藏版)》请在冰豆网上搜索。
软
件
开
发
流
程
规
范
V1.0
德联软件有限责任公司
编制人:
侯秀美审核人:
2015年8月19日
目录
目录 0
一、概述 2
二、开发流程规范 3
2.1系统软硬件开发环境 3
2.2系统架构(系统组成) 5
2.3系统功能模块设计 6
2.4系统功能开发流程图 6
2.5开发修改记录 7
三、开发代码规范 8
3.1文件结构 8
3.1.1文件信息声明 8
3.1.2头文件的结构 10
3.1.3定义文件的结构 11
3.1.4头文件的作用 12
3.1.5目录结构 13
3.2命名规则 13
3.2.1共性原则 13
3.2.2Windows变量命名规则 14
3.3程序风格 16
3.3.1空行 17
3.3.2代码行 18
3.3.3代码行内的空格 19
3.3.4对齐 20
3.3.5长行拆分 22
3.3.6修饰符的位置 23
3.3.7注释 23
3.4函数设计 26
3.4.1参数的规则 26
3.4.2返回值的规则 27
3.4.3函数内部实现的规则 30
3.4.4其它建议 32
3.4.5使用断言 32
3.4.6引用与指针的比较 33
3.5变量类型定义 35
四、软件测试规范 36
4.1单元测试 36
4.2系统测试 37
4.6业务测试 38
4.7验收测试 38
4.8用户现场测试 38
五、软件版本管理 39
4.1版本管理的必要性 39
一、概述
本文制定烟台开发区德联软件有限责任公司计算机软件开发规范文档。
本规范的目的是使公司软件开发项目阶段清晰、要求明确、任务具体、编写的代码规范,使之规范化、系统化和工程化,向公司内从事软件开发的工程师和管理人员提出一系列规范和要求,从而有利于开发过程的控制和管理,提高所开发软件系统的质量,缩短开发时间,减少开发和维护费用,以保证项目高质量、顺利进行。
本规范包含:
开发流程规范和开发代码规范等,开发流程规范需要技术开发人员编写相关内容,希望每个技术人员形成习惯,如有新的内容更新会及时通知大家,如有好的规范要求也可通知编制人员及时更新。
本规范为烟台开发区德联软件有限责任公司内部材料,严禁其他商业应用。
二、开发流程规范
接受开发任务,详细阅读软件技术规范或技术文档,如对技术文档有疑义或者不清楚的地方及时与项目总工或用户沟通,根据文档和沟通内容编写项目开发计划,必须包括但不限于系统软硬件开发环境、系统架构、系统功能模块设计、系统功能开发流程图、开发修改记录。
2.1系统软硬件开发环境
开发环境的搭建,最好形成文档,便于以后同样工作的使用。
开发人员要明确系统开发拟采用的数据库、操作系统、开发语言、开发工具、服务器等(具体到版本)。
明确整个系统开发工作流程,至少应该包括以下流程。
2.2系统架构(系统组成)
确定系统整体体系架构,各层次之间的数据流的连接,确定软件服务器的硬件配置及用户硬件资源配置,确定与用户软件平台的统一协调。
开发人员在绘制架构图时给出基本框架,能反映出基本意义即可,可以直接用文字代替例子中的图片。
图1系统逻辑架构图举例
图2物理架构图举例
2.3系统功能模块设计
给出系统的主要功能模块,每个模块所包含的功能。
图3图书管理系统模块规划图举例
2.4系统功能开发流程图
给出系统主要功能的业务流程图。
图4系统功能业务流程图举例
2.5开发修改记录
1.开发代码做好备份(可以在完成一个重大功能之后,或者按时间周期性进行备份),以免由于不可抗力导致代码不可修复。
2.在每次重大修改之后要做好记录(改动的具体细节),修改前的版本要及时备份,可以方面随时还原系统。
修改日期
修改内容
是否备份
备注
三、开发代码规范
在研究项目团队协作开发的情况下(这里的团队协作也适合于应用项目的开发),编程时应该强调的一个重要方面是程序的易读性,在保证软件速度等性能指标能满足用户需求的情况下,能让其他程序员容易读懂你所编写的程序。
若研究项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格,可以让协作者、后继者和自己一目了然,在很短的时间内看清楚程序结构,理解设计的思路,大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性。
制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性,提高软件的质量。
本规范由程序风格、命名规范、注释规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。
此规范以C/C++程序设计讨论。
3.1文件结构
每个C++/C程序通常分为两个文件。
一个文件用于保存程序的声明(declaration),称为头文件。
另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。
C++/C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀,C++程序的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。
3.1.1文件信息声明
文件信息声明位于头文件和定义文件的开头(参见示例3-1),主要内容有:
(1) 版权信息;
(2) 文件名称,项目代码,摘要,参考文献;
(3) 当前版本号,作者/修改者,完成日期;
(4) 版本历史信息;
(5) 主要函数描述。
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
//Copyright(c)2015,DeLianSoftCompanyYanTai
//Allrightsreserved.
//
//Filename:
filename.h
//ProjectCode:
Theprojectcodeaboutthisfile
//Abstract:
Describethecontentofthisfilesummarily
//Reference:
......
//
//Version:
1.1
//Author:
thenameofauthor(mender)
//Accomplisheddate:
September2,2004
//
//Replacedversion:
1.0
//OriginalAuthor:
thenameoforiginalauthor(mender)
//Accomplisheddate:
September10,2003
//
//Mainfunctions:
// Function1Returncode Functionname(ParameterExplain)
// Function2Returncode Functionname(ParameterExplain)
// ...
// FunctionnReturncode Functionname(ParameterExplain)
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
示例3-1文件信息声明
☆ 【规则3.1-1】 文件信息声明以两行斜杠开始,以两行斜杠结束,每一行都以两个斜杠开始;
☆ 【规则3.1-2】 文件信息声明包含五个部分,各部分之间以一空行间隔;
☆ 【规则3.1-3】 在主要函数部分描述了文件所包含的主要函数的声明信息,如果是头文件,这一部分是可以省略的。
3.1.2头文件的结构
头文件由三部分内容组成:
(1) 头文件开头处的文件信息声明(参见示例3-1);
(2) 预处理块;
(3) 函数和类结构声明等。
假设头文件名称为filesystem.h,头文件的结构参见示例3-2。
☆ 【规则3.2-1】 为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块;“#ifndef”或者“#define”后以TAB键代替SPACE键做空格;如果头文件名称是由多个单词组成,则各单词间以下划线“_”连接,例如有头文件名称为“filesystem.h”,则定义如下:
“#ifndef _FILE_SYSTEM_H_”;
☆ 【规则3.2-2】 用#include
☆ 【规则3.2-3】 用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索);
☆ 【建议3.2-1】 头文件中只存放“声明”而不存放“定义”;
☆ 【建议3.2-1】 头文件中应包含所有定义文件所定义的函数声明,如果一个头文件对应多个定义文件,则不同定义文件内实现的函数要分开声明,并作注释以解释所声明的函数从属于那一个定义文件;
☆ 【建议3.2-3】 宏定义和函数声明分离,在两个头文件中定义,如果没有类成员函数,可以将类和结构的定义与函数声明分离,也就是说一个头文件专用于宏定义,一个头文件专用于类和结构的定义,一个头文件专用于函数声明;
☆ 【建议3.2-4】 在C++语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。
这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。
建议将成员函数的定义与声明分开,不论该函数体有多么小。
头文件的结构如下:
//文件信息声明见示例3-1,此处省略。
#ifndef _FILE_SYSTEM_H_ //avoidreferencingthefilefilesystem.hrepeat
#define _FILE_SYSTEM_H_
#include
…
#include“myheader.h” //referencenon-standardheadfile
…
voidFunction1(…); //globalfunctiondeclare
…
classCBox //classstructuredecalre
{
…
};
#endif
示例3-2C++/C头文件的结构
3.1.3定义文件的结构
定义文件有三部分内容:
(1) 定义文件开头处的文件信息声明(参见示例3-1);
(2) 对一些头文件的引用;
(3) 程序
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 开发 流程 规范