diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index e69de29..0000000 diff --git a/README.md b/README.md index 65b4fbb..9caa66a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,432 @@ # text4 +2023年5月21日 + +董函铄 胡煜男 于博 袁楷昊 + +## 项目简介 + +本系统是程序设计与问题求解课程设计项目，是为教师提供管理班级成绩的工具，该系统可以实现的对学生的成绩进行增、删、改、查、信息保存和信息导入等基本功能，以及对学生成绩排序和分段的扩展功能，有利于对学生成绩管理。项目采用 C 语言编程实现，在 VS Code 集成开发环境（IDE）中用 GCC 进行编译。系统采用模块化设计，程序结构清晰，采用菜单驱动的命令行界面，操作便捷，能够用 CSV 格式读取和保存数据，通用性强，能够用图表展示数据，直观清楚。 + +下载地址：https://code.educoder.net/plebkff6w/text4 + +项目开发过程中采用 Kanban（看板）进行任务管理和分工协作，并使用 Git 对程序代码和文档进行版 +本管理。任务分工情况如下： + +| 任务 | 设计 | 开发 | 测试 | 文档 | +|---|---|---|---|---| +| C1-C3 菜单驱动的用户界面 | 董函铄 | 董函铄 | 胡煜男 | 董函铄 | +| C4 添加学生信息及成绩 | 胡煜男 | 胡煜男 | 于博 | 胡煜男 | +| C5: 查询学生信息及成绩 | 于博 | 于博 | 袁楷昊 | 于博 | +| C6: 打印学生信息及成绩 | 袁楷昊 | 袁楷昊 | 董函铄 | 袁楷昊 | +| C7: 修改学生信息及成绩 | 董函铄 | 董函铄 | 于博 | 董函铄 | +| C8: 删除学生信息及成绩 | 胡煜男 | 胡煜男 | 袁楷昊 | 胡煜男| +| C9: 学生信息及成绩记录排序 | 于博 | 于博 | 董函铄 | 于博 | +| C10: 从文件中读取学生信息及成绩记录 | 袁楷昊 | 袁楷昊 | 胡煜男 | 袁楷昊 | +| C11: 将学生信息及成绩保存保存到文件 | 董函铄 | 于博 | 胡煜男 | 董函铄 | +| C12: 以图表方式显示学生信息及成绩 | 董函铄 | 袁楷昊 | 于博 | 胡煜男 | + +每个成员的工作量（百分比）： + +| 董函铄 | 胡煜男 | 于博 | 袁楷昊 | +|---|---|---|---| +| 30 | 20 | 30 | 20 | + +## 关于实现学生成绩管理系统 + +设计一个学生成绩管理系统，要求采用命令行菜单界面进行交互，具备读取、保存、打印、查询、修改、插入、删除和排序等基本功能，能够以表格和图表形式展示数据，采用 CSV 格式保存数据。 + +系统的功能性需求： + +- 数据的读取、保存、打印、查询、修改、插入、删除、排序和图表展示。 + +系统的非功能性需求： + +- 菜单驱动的命令行交互界面。 + +## 需求分析 + +分析系统的功能需求和界面需求，编制用户手册如下。 + +#### C1:启动程序 + +命令行中执行命令 ./app , 系统启动，显示提示信息，然后显示功能菜单，等待用户输入命令。 + +``` +学生成绩管理系统启动 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择： +``` + +#### C2：显示命令菜单 + +``` +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择： +``` + +#### C3: 退出程序 + +选择菜单命令 `0`，再输入 `y` 确认，则退出程序。 + +``` +请选择：0 +确定要退出吗？(Y/N): y +程序退出 +``` + +#### C4: 添加库存记录 + +选择菜单命令 `5`，提示输入学号，若该学生不存在，则继续输入学号、姓名、成绩，添加学号，并提示完成；若学号已存在，则提示学号已存在，并结束。 + +``` +请选择：5 +输入学号：101 +输入姓名：小米 +输入成绩：80 +学生 101 已添加 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：5 +输入学号：101 +学号已存在. +``` + +#### C5: 查询学生信息及成绩 + +选择菜单命令 `4`，提示输入学号，若该学号存在，则输出学号、姓名、成绩；否则提示学生不存在并结束。 + +``` +请选择：4 +输入学号：101 +学号：101 +名字：小米 +成绩：80 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：4 +输入学号：101 +学号不存在. + +``` + +#### C6: 打印学生信息及成绩 + +选择菜单命令 `3`，打印 + +``` +请选择：3 +------------------------------------------------------- +| NUMBER | NAME | ON HAND | +------------------------------------------------------- +| 101 | 小李 | 80 | +------------------------------------------------------- + +``` + +#### C7: 修改学生信息及成绩 + +选择菜单命令 `7`，根据提示输入学号，若学号存在，则继续输入学号、姓名、成绩，并修改库存记录；否则，提示学号不存在并结束。 + +``` +请选择：7 +输入学号：104 +输入姓名：小刘 +输入成绩：96 +学生 104 已更新 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：3 +------------------------------------------------------- +| NUMBER | NAME | ON HAND | +------------------------------------------------------- +| 104 | 小刘 | 96 | +------------------------------------------------------- + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：7 +输入学号：104 +学生不存在. + +``` +#### C8: 删除库存记录 + +选择菜单命令 `7`，根据提示输入学号，若学号存在，则删除之；否则提示学号不存在并结束。 + +``` +请选择：7 +输入学号：100 +学号不存在. + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：7 +输学号：101 +学生 101 已删除 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：3 +------------------------------------------------------- +| NUMBER | NAME | ON HAND | +------------------------------------------------------- +------------------------------------------------------- + +``` +#### C9: 学生信息及成绩排序 + +选择菜单命令 `8`，对学生按学号从小到大排序。 + +``` +请选择：3 +------------------------------------------------------- +| NUMBER | NAME | ON HAND | +------------------------------------------------------- +| 101 | 小米 | 80 | +| 100 | 小明 | 70 | +------------------------------------------------------- + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：8 +排序 +排序已完成 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：3 +------------------------------------------------------- +| NUMBER | NAME | ON HAND | +------------------------------------------------------- +| 100 | 小明 | 70 | +| 101 | 小米 | 80 | +------------------------------------------------------- + +``` + +#### C10: 从文件中读取学生信息及成绩 + +选择菜单命令 `1`，提示输入文件名，若文件存在，则打开文件读取 CSV 格式保存的所有库存记录；否则，若文件不存在，则给出错误信息并结束。 + +假设文件 `a.csv` 中，以 CSV （Comma-Separated Values）格式保存了如下记录： + +``` +103,小红,80 +104,小光,100 +101,小米,80 +102,小明,70 +``` + +则读取记录的过程如下： + +``` +请选择：1 +读取数据 +请输入文件名：a.csv +读取 4 记录 + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：3 +------------------------------------------------------- +| NUMBER | NAME | ON HAND | +------------------------------------------------------- +| 103 | 小红 | 80 | +| 104 | 小光 | 100 | +| 101 | 小米 | 80 | +| 102 | 小明 | 70 | +------------------------------------------------------- + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +请选择：1 +读取数据 +请输入文件名：a +a: No such file or directory + +``` +#### C11: 将学生信息及成绩保存到文件 + +选择菜单命令 `2`，提示输入文件名，将所有库存记录以 CSV 格式保存到指定的文件中。 + +``` +请选择：2 +保存数据 +请输入文件名：b.csv +保存 4 记录 + +``` +#### C12: 以图表方式显示学生信息及成绩 + +选择菜单命令 `9`，以图表方式显示库存记录。 + +``` +请选择：9 +图表 + 103 : 小红 | ******** (80) + 104 : 小光 | ************ (100) + 101 : 小米 | ******************** (80) + 102 : 小明 | ********** (70) + +1 读取 | 2 保存 | 3 打印 | 4 查询 | 5 添加 +6 修改 | 7 删除 | 8 排序 | 9 图表 | 0 退出 + +``` + +## 概要设计 + +系统主要分为用户界面和数据处理两大模块。 +用户界面模块包括系统初始化（init），显示菜单（display_menu），选择菜单命令（make_choice）、确认（confirm）、退出（quit）等子模块。 +数据处理模块包括读取数据（read_data）、保存数据（save_data）、打印数据（print_data）、查询数据（query_data）、添加数据（add_data）、更新数据（update_data）、删除数据（delete_data）、数据排序（sort_data）和生成图表（make_chart）等子模块。其中查询、添加、更新和删除数据还会用到根据编号查询数据的方法（find）。 + +上述各模块通过主程序（main）进行调用，系统模块图如下。 + +![](pictures/xitongmoban.drawio.svg) + + + +各模块的主要功能如下： + +#### main + +系统主函数模块，显示菜单，根据用户选择的菜单命令，执行相关操作。 + +#### init + +系统初始化。 + +#### display_menu + +显示菜单命令。 + +## 详细设计 + +针对概要设计 + +#### main + +Step 1: 初始化 +Step 2: 根据用户选择的命令执行对应的操作 +Step 2.1: 显示菜单 +Step 2.2: 选择菜单命令 c +Step 2.3: if c == CMD_READ then 读取数据 +Step 2.4: if c == CMD_SAVE then 保存数据 +Step 2.5: if c == CMD_PRINT then 打印数据 +Step 2.6: if c == CMD_QUERY then 查询数据 +Step 2.7: if c == CMD_ADD then 添加数据 +Step 2.8: if c == CMD_UPDATE then 修改数据 +Step 2.9: if c == CMD_DELETE then 删除数据 +Step 2.10: if c == CMD_SORT then 排序数据 +Step 2.11: if c == CMD_MAKE then 显示图表 +Step 2.12: if c == CMD_QUIT then 退出 + + +![](pictures/main_chart.drawio.svg) + + +#### read_data + +Step 1: 输入文件名 +Step 2: 打开文件 +Step 3: if 文件为空 then 结束 +Step 4: else 读取文件 +Step 5: 提示读取并记录 + +![](pictures/read.drawio.svg) + + +#### save_data + +Step 1: 输入文件名 +Step 2: 打开文件 +Step 3: if 打开文件失败 then 提示打开文件失败并结束 +Step 4: 将所有库存记录写入文件 +Step 5: 关闭文件 + +![](pictures/save_data.drawio.svg) + +#### print_data + +Step 1: 输出学号、姓名、成绩 + +![](pictures/print.drawio.svg) + +#### query_data + +Step 1: 输入学生学号 +Step 2: if学号不存在 then 提示学生不存在并结束 +Step 3: else 学号存在 then 输出学号、姓名、成绩 + +![](pictures/query_data.drawio.svg) + +#### add_data + +Step 1: if 数据库满 then 提示数据库满并结束 +Step 2: 输入学号 +Step 3: if 学生已存在 then 提示学生已存在并结束 +Step 4: 输入学生名字和成绩 +Step 5: 添加学生到数据 +Step 6: 提示添加成功 + +![](pictures/add_data.drawio.svg) + +#### update_data + +Step 1: 输入学号 +Step 2: if 不存在 then 提示学生不存在并结束 +Step 3: else 输入学号、姓名、成绩 +Step 4: 已更新 + +![](pictures/updata_data.drawio.svg) + +#### delete_data + +Step 1: 输入学号 +Step 2: if 不存在 then 提示学生不存在并结束 +Step 3: else 删除学生信息 +Step 4: 提示删除成功 + +![](pictures/delete.drawio.svg) + + +#### sort_data +Step 1: 读取文件 +Step 2: 进行排序 +Step 3: 提示排序已完成 + +![](pictures/sort.drawio.svg) + + +#### make_chart + +Step 1: 读取文件 +Step 2: 显示图表 + +![](pictures/make_chart.drawio.svg) + + +#### confirm + +Step 1: 输出 确定要退出吗 +Step 2: if 确认 then 退出 + +![](pictures/confirm.drawio.svg)