四则运算程序的分析与设计

一、项目分工

​

人员	工作
姬龙龙，郑震	需求分析、博文撰写
林明杰	顺序图和类图
兰静莹，李润泽	用例图和用例规约
五人商讨	编码规范

二、需求分析

1.网上问卷调研

1. 您的身份是？

   A.教师 B.学生 C.家长

2. 您喜欢使用什么方式做题？

   A.手机 B.电脑 C.练习册

3. 您需要什么功能的做题系统？

   A.娱乐性 B.防作弊 C.系统化

4. 您觉得，需要给予孩子奖励的功能吗？

   A.需要 B.不需要 C.可有可无

5. 做题系统需要家长自己参与吗？

   A.需要 B.不需要 C.随意

---

网上调研结果如下：

• 用户A　　AABCB
• 用户B　　ACCAA
• 用户C　　BACBA

---

2.软件需求规格说明书

详细的功能及系统架构请右转 ----> 码云

---

三、原型设计

​ 一个可用可交互的原型所带来的好处并不是一星半点，它还可以帮助开发和设计人员从不同的维度上来规划和设计产品。原型是帮助网站与APP设计最终完成标准化和系统化的最好手段。

墨刀 <---- 墨刀链接地址请左转

---

四、用例图、用例规约

1.用例图

2.主要用例规约（其余都在码云仓库）

注册：

名称	用户注册
用例ID	Szys01
角色	用户
说明	本用例描述用户主动注册过程。每个用户必须注册后才能进入系统。学生注册需填写学号、密码、班级等信息，教师注册需填写教师号、密码等信息。家长注册需填写家长号、密码、学生学号等信息。用例起始于点击“注册”按钮。
前置条件	用户未注册或想注册新账号
基本事件流	1. 用户点击页右上方的“注册”，或者在登录页面上点击“注册”。 2. 用户选择注册的身份。 3. 用户根据系统提示输入信息（用户名、密码、邮箱等等）。 4. 用户确认信息无误，点击“提交”按钮 。5. 系统提示“新用户注册成功”
其它事件流	用户在任何一步均可以退出
异常事件流	3.1如果用户输入无效的信息（例如用户名存在，用户名为空，密码为空，密码不合法等等），系统显示错误信息。用户重新输入，返回基本事件流2；
后置条件	注册成功，用户返回登录界面

登陆：

名称	用户登录
用例ID	Szys02
角色	用户
说明	本用例描述用户选择身份，输入用户名密码登录的过程。用例起始于点击“登录”按钮。
前置条件	用户已注册
基本事件流	1. 用户点击页面右上方“登录” 2. 用户选择身份，并输入用户名和密码 3. 用户点击“登录”按钮，用户验证用户名和密码
其它事件流	用户在任何一步均可以退出
异常事件流	3.1如果用户输入无效的信息（例如用户名存在，用户名为空，密码为空，密码不合法等等），系统显示错误信息。用户重新输入，返回基本事件流2；
后置条件	注册成功，用户返回登录界面

五、顺序图

出题细节

做题细节

学生使用流程

教师使用流程

家长使用流程

六、类图

七、编码规范

一 、代码编排

• 缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。
• 每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。
• 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

二、注释

​总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！ 注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

• 块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。
•  行注释，在一句代码后加注释。比如：x = x + 1 # Increment x
• 避免无谓的注释。

三、命名规范

总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。

• 尽量单独使用小写字母‘l’，大写字母‘O’等容易混淆的字母。
• 模块命名尽量短小，使用全部小写的方式，可以使用下划线。
• 包命名尽量短小，使用全部小写的方式，不可以使用下划线。
• 类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。

转载于:https://www.cnblogs.com/lcglaoji/p/9063485.html