WORD 格式
资料概要设计说明书1.导言1
1 目的本文档的目旨在推动软件工程的规范化, 对本系统的业务流程、软件架构、功能模块设计 、数据库设计 、接口设计等做了分析和说明,使设计人员遵循统一的软件设计规范,降低系统实现的风险,做到系统设计文档的规范性与全面性 ,以利于整个系统的实现 、测试 、维护等
2 范围本文档用于软件设计阶段的概要设计,它的依据的基线是《需求分析规格书》,它的下游是 《详细设计说明书》,并为 《详细设计说明书》提供测试的依据
软件概要设计的范围是: 软件系统业务流程分析、总体结构设计 、全局数据库和数据结构设计、外部接口设计 、主要部件功能分配设计、部件之间的接口设计等方面的内容
该范围应覆盖 《需求规格说明书 》中的功能点列表 、性能点列表
3 命名规则1
1 变量对象命名规则 :1、局部变量 : 采用驼峰式命名规则 ,第一单词全小写 ,其他单词首字母大WORD 格式
例如 :userName
2、全局变量 :首字母为大写的P,后面与局部变量的命名一致
例如 :PuserName
3、函数名 :
采用驼峰式命名规则 ,第一单词全小写 ,其他单词首字母大写例如 :addUser()
4、常量 :所有字母均要小写
例如:name
5、类:首字母为大写的 C,其他的单词首字母都大写
例如 :CUser
6、对象 :与局部变量命名规则一致
例如: userOne
2 数据库对象命名规则 :1、数据库表名 :采用驼峰式命名规则
例如:cpInfo
2、字段名 :表名首字母小写加下划线加相应单词小写
若表名首字母相同的,则在字段名的前两个字母为表名的前两个字母小写
例如 :u_name
3、索引名 :“index_”加相应的名称
例如:index_