一、软件文档概述

1 代码规范

1）“开发程序的软件很多，但是它们的检查方式全是检查语法，并没有规定变量命名以及方法的命名，所以注释是很必要的东西。”——注释

对变量及方法进行相应的注释，可使代码易于维护，程序并非一次性的产品，它需要扩展、修改还有维护。

2）“变量名、函数名，都只敲一遍，以后全部是拷贝+粘贴。”——拷贝+粘贴

可防止因少或多打一两个字母，而出现的bug问题。

3）“标识符的首字母小写，而每个后面连接的单词的首字母都大写。”——小大写

在命名变量或方法名时，遵循统一的命名规则，尽量做到名如其义，且命名时首字母小写，其后的单词首字符都大写。

4）“缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。”——缩进

表现代码的逻辑层次，易于查看，每行的一个Tab是指基于上层或所在逻辑结构，并非都是基于本行开头部分。

5）“空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。

在代码中，不能包含多个空行。

在以下情况下使用一个空行：

（1）方法中变量声明与语句之间。

（2）方法与方法之间。

（3）方法中不同的逻辑块之间。

（4）方法中的返回语句与其他的语句之间。

（5）属性与方法、属性与字段、方法与字段之间。

6）注释与它注释的语句间不空行，但与其他的语句间空一行。”——空行

其基本原则是在每一个小的逻辑块之间加空行。

7）“（1）左花括号‘{’与关键字或方法名在同一行，中间置一个空格。

（2）右花括号‘}’要与相应的左花括号‘{’所在方法对齐，单独成行。”

——花括号

例如：

public void add() {

......

}

8）“建议在变量声明时就对其做初始化。”——初始化

9）“变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。”——声明变量的位置

若此变量并非只在局部被使用一次，其声明就应该放在本块的开始部分，方法内部较靠前的位置进行变量的声明，易于查看和维护。

10）对于属性的设置，尽量设置为private类型，对于它的调用，可通过其get或set方法，这样要比直接将其设置为public要好一些。——属性的类型设置

11）switch-case语句使用格式

switch(condition) {

case 1:

statements;

break;

case 2:

statements;

break;

default:

statements;

break;

}

注意：

（1）每个case各占一行。

（2）每个case按照字母顺序进行排序。

（3）每个非空case均提供break;结束语句。

（4）每个switch语句均提供default分支。   ——switch语句的结构

二、软件的结构

2.1软件结构的层次图

图2-1 软件结构层次图

三、各模块的详细说明和活动图

3.1 运行模块组合

通过软件结构层次图可以看出通过登陆模块可以链接团体模块和个人模块。团体模块可以调用教室查询模块和教室预定模块；个人模块可以调用教室智能推荐模块和教室属性筛选模块

3.2 详细说明

1）软件登陆模块：该模块设有登陆、注册两类输入接口，登陆接口链接数据库，与数据库的信息相匹配，判断用户是否能登陆系统；注册接口负责审查用户注册信息是否合规，不合规不予输入数据库，合规则存入数据库中。

活动图：

2）团体模块：团体模块中可以查看团体账户信息、进行预定时间的选择、该时间段内空教室的信息预览、该时间段内空教室的预定、已预定教室的信息现实、已预定教室的退订。将改变预定的教室在数据库内的状态，及在数据库内录入预定人的信息。

活动图：

3）个人模块：个人模块中可以查看个人账号信息、智能推荐合适的教室、可以筛选教室的属性。个人账号不提供预定功能。可以通过条件筛选适合自己的教室。

活动图：

四、数据的结构

4.1数据表及结构体定义

五．人机界面

5.1登录界面图

5-1登录界面图

5.2内部界面

5-2内部信息界面图

原文地址：https://www.cnblogs.com/huangjinmeilihao/p/11867047.html