文档介绍：网上订餐系统编码实现
目录
网上订餐系统概要设计 1
目录 2
1. 导言 4
. 目的 4
. 范围 4
. 缩写说明 4
. 术语定义 4
. 引用标准 5
. 参考资料 5
. 版本更新信息 5
2. 系统框架 6
3. 系统功能 6
. 管理员功能 6
. 客户功能 7
4. 界面设计 8
. 管理端操作界面 9
. 客户端操作界面 11
5. 体系结构 11
. 体系结构 12
. struct体系结构 12
. 系统体系结构 14
. 系统进行环境 16
. 网络结构图 16
. 硬件环境 17
. 软件环境 17
6. 数据模型 18
. 系统E-R图设计 19
. 数据库的逻辑结构模型设计 19
. 数据库物理结构模型设计 21
7. 模块设计 22
. 客户端模块设计 22
. 表示层设计 23
. 控制层 23
. 模型层 23
. 系统管理模块设计 24
. 表示层设计 24
. 控制层设计 24
. 会员管理模块设计 24
. 表示层设计 24
. 控制层设计 25
. 菜肴管理模块设计 25
. 表示层设计 26
. 控制层设计 26
. 模型层设计 26
8. 签字 26
导言
目的
该文档的目的是描述网上订餐系统项目的编码规范和对代码的说明,其主要内容包括:
编码规范
命名规范
注释规范
语句规范
声明规范
目录设置
代码说明
本文档的预期的读者是:
开发人员
项目管理人员
质量保证人员
范围
该文档定义了本项目的代码编写规范,以及部分代码描述和所有代码的说明。
缩写说明
无
术语定义
无
引用标准
[1] 《企业文档格式标准》
北京长江软件有限公司
[2] 《Java语言编写规范》
北京长江软件有限公司软件工程过程化组织
参考资料
[1] 《实战struct》〔美〕Ted Husted
机械工业出版社
[2] 《软件重构》
清华大学出版社
版本更新信息
本文档的更新记录如下表。
修改编号
修改日期
修改后版本
修改位置
修改内容概述
001
全部
初始发布版本
002
细节
增加
003
细节
修改
004
细节
修改
005
细节
增加
命名规范
命名规范使程序更易读,从而更易于理解。它们也可以提供一些有关标识符功能的信息,以助于理解代码。
包(Packages)
一个包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,, edu, gov, mil, net, org, 或1981年ISO3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成部门(department),项目(project),机器(machine),或注册名(login names)。
如:
.
类(Classes)
类名是一个名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像URL,HTML)。
接口(Interfaces)
大小写规则与类名相似。
方法(Methods)
方法名是一个动词,采用大小写混合的方式,第一个单词的首字母大写,其后单词的首字母大写。
变量(Variabies)
采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i, j, k, m和n,它们一般用于整形;c, d, e,它们一般用于字符型。
实例变量(Instance Variables)
除了前面需要一个下划线,大小写规则和变量名相似,如:int_employeeId。
常量(Constants)
类常量和ANSI常量的声明,应该全部大写,单词间用下划线隔开。
声明规范