Doxygen(三) 使用Markdown配置主界面

项目名称： “高校社团活动与财务管理系统” 1. 项目背景 在大学校园中，社团众多，活动频繁，涉及人员变动、活动审批及经费报销等复杂流程。目前很多社团仍采用Excel或纸质管理，导致信息不同步、账目混乱。本项目旨在开发一个基于命令行的管理系统，帮助社团负责人高效管理人员、活动及财务。 2. 教学目标 ● 工程能力： 掌握多文件编译、模块化编程、头文件封装。 ● 协作能力： 熟练使用Git进行分支管理、代码合并及冲突解决。 ● 编程基础： 深入理解结构体链表/数组、文件读写（数据持久化）、指针操作及内存管理。 ● 复杂问题解决： 处理数据关联（如：活动消耗了多少经费，需扣除社团总余额）、错误处理及健壮性设计。 3. 功能需求说明 (Functional Requirements) 3.1 基础功能 (必做) 1. 用户权限管理： ○ 管理员（社联）： 拥有最高权限，可审批新社团注册、注销社团。 ○ 社长： 管理本社团成员、发布活动、申请经费。 ○ 普通成员： 查看社团信息、报名参加活动、查询个人状态。 ○ 要求：需实现登录、注册、密码加密（简单的异或加密即可）及数据持久化。 2. 社团与成员管理： ○ 增删改查（CRUD）社团信息（名称、成立时间、负责人）。 ○ 成员的加入、退出、职位变更（干事/部长）。 ○ 数据结构考查：链表操作。 3. 财务管理模块： ○ 记录每一笔收入（会费、赞助）和支出（活动报销）。 ○ 支持按时间段导出简单的财务报表（打印到屏幕或导出为.txt）。 ○ 逻辑考查：确保余额不能为负，流水账必须与余额对应。 3.2 进阶功能 (选做/高分项) 1. 活动报名与冲突检测： ○ 成员报名活动时，检测该成员在同一时间段是否已报名其他活动（时间重叠检测）。 2. 模糊搜索与排序： ○ 支持按社团人数、经费余额进行排序显示。 ○ 支持按关键字模糊搜索社团或活动。 3. 数据恢复与日志： ○ 系统启动时从文件加载数据，退出时自动保存。 ○ 记录简单的系统操作日志（如：User A deleted Activity B at [Time]）。 4. 技术与工程约束 (Technical Constraints) 1. 开发环境： GCC / Clang / Visual Studio (MSVC)。 2. 版本控制（核心要求）： ○ 必须使用 Git 进行版本控制。 ○ 项目必须托管在 GitHub/Gitee/GitLab 上。 ○ Commit 规范： 提交信息清晰（如 feat: add login function, fix: memory leak in delete_node）。 ○ 分支策略： 禁止直接在 master/main 分支开发，需使用 Feature Branch Workflow（每个人在自己的分支开发，完成后 Merge）。 3. 代码规范： ○ 模块化： 禁止将所有代码写在 main.c 中。需至少划分为 main.c, auth.c/.h (认证), club.c/.h (社团逻辑), finance.c/.h (财务), utils.c/.h (通用工具) 等。 ○ 注释： 关键函数需有 Doxygen 风格的注释。 4. 健壮性： ○ 输入必须校验（如输入数字处输入了字母，程序不能崩溃）。 ○ 严禁内存泄漏（查找相关工具自测，或在演示时无泄漏）。 5. 团队分工建议 (Teamwork) 设定角色： ● 成员 A (系统架构与数据核心)： ○ 负责定义结构体 (struct) 和全局数据结构。 ○ 负责底层链表/数组的增删改查函数封装。 ○ 负责文件读写 (File I/O) 模块。 ● 成员 B (业务逻辑与交互界面)： ○ 负责菜单设计、用户输入输出交互。 ○ 负责业务逻辑串联（如：调用A写的函数完成“报名”动作，并判断余额是否足够）。 ○ 负责登录注册逻辑及权限控制。 注意：两人必须都有代码贡献，Git Log 将作为评分重要依据。 6. 一周工作计划表 (Schedule) ● Day 1：需求分析与接口定义 ○ 讨论需求，画出功能思维导图。 ○ 关键： 确定 struct 定义和 .h 文件中的函数声明。 ○ 初始化 Git 仓库，建立 .gitignore。 ● Day 2：核心模块开发 ○ A 开发链表操作和文件读取雏形。 ○ B 开发主菜单框架和部分交互界面。 ● Day 3：功能迭代 ○ A 完成数据管理模块，B 完成登录注册模块。 ○ 进行第一次代码合并，解决可能出现的冲突。 ● Day 4：业务逻辑完善 ○ 实现财务管理、活动冲突检测等复杂逻辑。 ○ 联调测试，确保 A 的数据层能支持 B 的业务层。 ● Day 5：测试与优化 ○ 进行边界测试（空数据、非法输入）。 ○ 代码重构，添加注释，美化控制台输出。 ● Day 6-7：文档撰写与答辩准备 ○ 撰写《软件设计说明书》。 ○ 准备 PPT，录制演示视频。 注：此计划只是使用Day来作为一个计量参考单位，实际工作量会根据具体的功能设计而变化。 7. 评价标准 (Grading Rubric) - 总分 100分 7.1 工程规范与协作 (30分) ● Git 使用 (15分)： 有清晰的提交历史，不仅仅是最后一天一次性提交；两人都有贡献；有分支合并记录。 ● 代码风格 (10分)： 变量命名规范，缩进统一，模块划分合理（.h/.c分离），无大量重复代码。 ● 编译构建 (5分)： 提供 Makefile 或清晰的编译说明，能够一键编译运行。 7.2 功能实现 (30分) ● 基础功能 (20分)： 增删改查、登录注册、文件读写功能正常。 ● 复杂逻辑 (5分)： 财务计算准确、数据关联性处理得当（如删除社团需级联删除其活动）、多级菜单逻辑清晰。 ● 健壮性 (5分)： 输入容错处理，无明显的 Segmentation Fault。 7.3 文档与答辩 (30分) ● 设计文档 (10分)： 包含流程图、数据结构定义、模块接口说明。 ● 现场答辩 (20分)： ○ 能流畅演示系统。 ○ 能准确回答老师关于代码细节的提问（用于甄别代写）。 ○ “随机抽查”：老师现场要求修改一行代码或增加一个小功能，看学生能否快速定位并实现。 7.4 创新与深度 (10分) ● 实现了模糊搜索、排序算法、密码加密、界面美化（如使用颜色库）、或使用了高级数据结构（如二叉树索引）。 8. 成果交付(Achievement Delivery) 8.1交付物清单 1. 源码包： 包含所有 .c, .h 文件及相关项目文件。 2. Git 仓库截图/链接： 证明版本控制过程。 3. 数据文件： 系统默认的初始化数据文件（.txt 或 .dat）。 4. 课程设计报告： PDF格式，含需求分析、系统设计、测试报告、心得体会。 5. 《软件设计说明书》等相关文档，项目功能演示视频。 8.2交付方式 登录聊城大学U+平台https://lcu.eduplus.net/，在程序设计基础课程中的实验部分进行提交。 注意： 1. 因为平台的原因，实验报告是必交项，课程项目不需要实验报告，同学们随意上传一个小Word文档即可。 2. 其他的交付物分类放在文件夹中，压缩成一个zip文件上传。 3. 项目文件可以是从git仓库中下载的源代码，不要包含生成的目标文件临时文件，如果是VS的话，不需要.vs目录，也不需要.git目录。 4. 功能演示的视频要有解说，可以使用截图工具，如FSCapture，也可以使用其它录屏工具。要控制视频的大小，时长不限，能展示完项目的功能即可。 8.3截止时间 2025年的最后一天。 附录：项目开发自学资源与参考指南(Recommended Learning Resources) 鉴于本次课程设计要求使用工程化的开发方式（多文件编译、版本控制、团队协作），以下精选了互联网上最适合初学者的免费教程，同学们在动手写代码前查阅。 1. Git 与版本控制（强烈建议） 这是本次课设的核心难点，请务必掌握基础的 add, commit, push, pull 以及分支合并操作。 ● [视频] 一小时Git教程 (GeekHour) ○ 推荐理由： B站播放量极高的入门视频，画风清晰，解释了 Git 的原理，非常适合完全没概念的初学者。 ○ 链接： Bilibili - GeekHour Git教程 ● [练习] Learn Git Branching (闯关游戏) ○ 推荐理由： 一个在浏览器里运行的 Git 模拟器。像玩游戏一样学习分支（Branch）和合并（Merge），能直观看到分支树的变化。建议花 1 小时通关基础篇。 ○ 链接： Learn Git Branching 中文版 ● [文档] 廖雪峰的 Git 教程 ○ 推荐理由： 经典的图文教程，步骤详细。如果遇到不懂的命令，可以当作字典查询。重点看“多人协作”一章。 ○ 链接： 廖雪峰 Git 教程 ● [平台] Gitee (码云) 帮助文档 ○ 推荐理由： 考虑到 GitHub 国内访问速度较慢，推荐使用国内的 Gitee 托管代码。官方文档详细介绍了如何将本地代码推送到远程仓库。 ○ 链接： Gitee 快速入门 2. C 语言模块化与多文件编程 告别将所有代码写在 main.c 里的习惯，学习如何使用头文件 (.h)。 ● [视频] 浙江大学翁恺老师 - C语言程序设计 (多文件编译章节) ○ 推荐理由： 中国最好的 C 语言启蒙老师。请在 B 站搜索“翁恺 C语言”，重点观看关于“大程序结构”、“头文件”、“声明与定义”的章节。 ● [文章] 为什么 C 语言需要头文件？ ○ 推荐理由： 解释了 .h 和 .c 的区别，以及 #ifndef (头文件卫士) 的作用。 ○ 链接： C语言中文网 - C语言模块化编程 (或直接搜索相关关键词) 3. 开发工具与编译构建 (Makefile) 工欲善其事，必先利其器。对于爱折腾的同学，不甘于使用VS开发环境的，可以尝试配置其它的开发环境。 ● [教程] VS Code 配置 C/C++ 环境保姆级教程 ○ 推荐理由： 很多同学卡在环境配置上。推荐 B 站搜索“VSCode C语言配置”，找最新日期的视频跟随配置。 ● [教程] 跟我一起写 Makefile (陈皓) ○ 推荐理由： 经典的 Makefile 教程。虽然内容很深，但大一学生只需看前三章，学会简单的 target: dependencies 规则即可。 ○ 链接： 跟我一起写 Makefile (PDF/网页版) 4. 文档编写 (Markdown) README.md 和设计文档推荐使用 Markdown 编写，简单美观。 ● [工具] Markdown 官方教程 ○ 推荐理由： 5分钟就能学会如何写标题、列表、代码块和插入图片。 ○ 链接： Markdown 语法说明 给同学们的建议 (Tips) 1. 不要畏难： 刚开始接触 Git 可能会觉得麻烦，经常报错，这是正常的。遇到 Conflict (冲突) 不要慌，百度/Google 搜索错误信息，通常只需手动修改文件即可解决。 2. 多提交： 哪怕只写好了一个函数，也可以 Commit 一次。千万不要写了一周代码，最后一天才 Commit，一旦硬盘损坏或改乱了代码，后果不堪设想。 3. 勤沟通： 两人小组最大的挑战不是代码，而是“我觉得你会写这个，结果你没写”。每天花 10 分钟对齐进度。程