团队作业(三):确定分工
1、修改完善上周提交的需求规格说明书
2、代码规范和编码原则
一、程序风格:
- 严格采用阶梯层次组织程序代码
每层次缩进为4格,括号位于下一行。要求相匹配的大括号在同一列,对继行则要求再缩进4格 - 提示信息字符串的位置
在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。 - 对变量的定义,尽量位于函数的开始位置。
二.命名规则
- 只能由字母、数字、下划线组成;
- 第一个字符必须是英文字母;
- 有效长度为255个字符;
- 不可以包含标点符号和类型说明符%,&,!,# ,@,$;
- 不可以是系统的关键词比如else
三.注释
- 注释要简单明了。
- 边写代码边注释,修改代码同时修改相应的注释,以保证 注释与代码的一致性。
- 在必要的地方注释,注释量要适中。注释的内容要清楚,明了,含义准确,防止注释 二义性。保持注释与其描述的代码相邻,即注释的就近原则。
- 对代码的注释应放在其上方相邻位置,不可放在下面。
- 对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域 的注释应放在此域的右方;同一结构中不同域的注释要对齐。
- 变量、常量的注释应放在其上方相邻位置或右方。
- 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
四。可读性
- 避免使用不易理解的数字,用有意义的标识来替代。
- 不要使用难懂的技巧性很高的语句。
- 源程序中关系较为紧密的代码应尽可能相邻。
五.函数,过程
- 函数的规模尽量限制在200行以内。
- 一个函数最好仅完成一件功能。
- 为简单功能编写函数。
- 函数的功能应该是可以预测的,也就是只要输入数据相同就应产生同样的输出。
- 尽量不要编写依赖于其他函数内部实现的函数。
- 避免设计多参数函数,不使用的参数从接口中去掉。
- 用注释详细说明每个参数的作用、取值范围及参数间的关系。
六.变量编辑
- 去掉没必要的公共变量。
- 构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共变量,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。
- 仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
- 明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。
- 当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。
- 防止局部变量与公共变量同名。
七.代码编译
- 编写代码时要注意随时保存,并定期备份,防止由于断电、硬盘损坏等原因造成代码丢失。
- 同一项目组内,最好使用相同的编辑器,并使用相同的设置选项。
- 合理地设计软件系统目录,方便开发人员使用。
- 打开编译器的所有告警开关对程序进行编译。
- 在同一项目组或产品组中,要统一编译开关选项。
- 使用工具软件对代码版本进行维护。
3、数据库设计及相应ER图
4、后端架构设计
本项目使用基于 MVC 模型的 Django 应用框架进行开发
MVC模型:
MVC 模式(Model–view–controller)是软件工程中的一种软件架构模式,把软件系统分为三个基本部分:模型(Model)、视图(View)和控制器(Controller)。
MVC 以一种插件式的、松耦合的方式连接在一起。
MVC优势:
低耦合
开发快捷
部署方便
可重用性高
维护成本低
特点:
强大的数据库功能
自带强大的后台功能
优雅的网址
项目架构
Web sever
项目整体上架构如上图, Nginx负责负载均衡,分发流量到Django服务,Django服务会分为两部分,分别为普通用户端和管理员端。
5、团队分工
燃尽图
6、队员分工和工作量比例
1、负责人:李祎铭 工作量:80%
负责人:沙桐 工作量:20%
2、负责人:杨越麒 工作量:100%
3、负责人:李祎铭 工作量:80%
负责人:曾宇涛 工作量:20%
4、负责人:曾宇涛 工作量:100%
5、负责人:薛胜瀚 工作量:40%
负责人:何家豪 工作量:40%
负责人:冶廷瑞 工作量:20%