一、团队项目的码云git代码库
https://gitee.com/kaoyanchaxunxitong
二、团队的代码规范与原则
（一）、程序风格：
1.严格采用阶梯层次组织程序代码每层次缩进为4格，括号位于下一行。要求相匹配的大括号在同一列，对继行则要求再缩进4格
2.提示信息字符串的位置在程序中需要给出的提示字符串，为了支持多种语言的开发，除了一些给调试用的临时信息外，其他所有的提示信息必须定义在资源中。
3.对变量的定义，尽量位于函数的开始位置。
（二）、命名规则
变量名的命名规则:驼峰命名法
（三）、注释
1. 注释要简单明了。
2.边写代码边注释，修改代码同时修改相应的注释，以保证 注释与代码的一致性。
3.在必要的地方注释，注释量要适中。注释的内容要清楚，明了，含义准确，防止注释 二义性。保持注释与其描述的代码相邻，即注释的就近原则。
4.对代码的注释应放在其上方相邻位置，不可放在下面。
5.对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域 的注释应放在此域的右方；同一结构中不同域的注释要对齐。
6.变量、常量的注释应放在其上方相邻位置或右方。
7.全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
8.在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。
9.在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入，输出及返回值说明；调用关系及被调用关系说明等。
（四）、可读性
- 避免使用不易理解的数字，用有意义的标识来替代。
- 不要使用难懂的技巧性很高的语句。
- 源程序中关系较为紧密的代码应尽可能相邻。
（五）、函数与过程
- 函数的规模尽量限制在200行以内。
- 一个函数最好仅完成一件功能。
- 为简单功能编写函数。
- 函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出。
- 尽量不要编写依赖于其他函数内部实现的函数。
- 避免设计多参数函数，不使用的参数从接口中去掉。
- 用注释详细说明每个参数的作用、取值范围及参数间的关系。
- 检查函数所有参数输入的有效性。
- 检查函数所有非参数输入的有效性，如数据文件、公共变量等。
- 函数名应准确描述函数的功能。
- 避免使用无意义或含义不清的动词为函数命名
- 函数的返回值要清楚、明了，让使用者不容易忽视错误情况。
- 明确函数功能，精确（而不是近似）地实现函数设计。
- 减少函数本身或函数间的递归调用。
- 编写 可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。
（六）、变量编辑
1.去掉没必要的公共变量。
2.构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。
3.仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
4.明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。
5.当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。
6.防止局部变量与公共变量同名。
7.仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减 少引起误用现象。
8.结构的设计要尽量考虑 向前兼容和以后的版本升级，并为某些未来可能的应用保留余地（如预留一些空间等）。
9.留心具体语言及编译器处理不同数据类型的原则及有关细节。
10.严禁使用未经初始化的变量。声明变量的同时对变量进行初始化。
11.编程时，要注意数据类型的 强制转换。
（七）、代码编译
- 编写代码时要注意随时保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。
- 同一项目组内，最好使用相同的编辑器，并使用相同的设置选项。
- 合理地设计软件系统目录，方便开发人员使用。
- 打开编译器的所有告警开关对程序进行编译。
- 在同一项目组或产品组中，要统一编译开关选项。
- 使用工具软件对代码版本进行维护。
三、团队项目数据库设计及ER图
（一）、目的
考研信息查询平台常用功能模块的数据库设计
（二）、模块
用户：注册、登录、查询
信息：浏览、管理
(三）、数据库结构设计
（1）用户表设计
用户表（Customer）
|
用户名（username） |
|
密码（password） |
|
出生年月（birthday） |
|
性别（sex） |
|
手机号码（telephone） |
|
用户地址（address） |
（2）数据表设计
数据表（DB）
|
考研学校（school） |
|
考研专业（major） |
|
考试科目（subject） |
|
考研学校地址（sc_address） |
(四)、数据库设计代码
（1）Customer表
|
create table Customer( username varchar(20) PRIMARY KEY not NULL COMMENT '用户名', password VARCHAR(20) not NULL comment '密码', birthday DATE COMMENT '出生日期', telephone int(13) not null UNIQUE KEY comment '手机号码', user_address varchar(40) comment'用户住址'); |
（2）DB表
|
create table DB( school varchar(20) not NULL COMMENT '考研学校', major VARCHAR(20) not NULL comment '考研专业', CONSTRAINT sc_major PRIMARY key(school,major), subject DATE not null COMMENT '考试科目', sc_address VARCHAR(50) not null comment '考研学校地址'); |
(五)、E-R图
四、体系结构图
五、组员分工
1、柔柔：
建立团队项目的码云git代码库，并列出地址
代码规范和编码原则。
2、妍妍：
通过Powerdesigner等工具完成团队项目的数据库设计，并提供相应ER图。
3、金金、凤凤：
进行项目的体系结构设计，并列出体系结构图。
浙公网安备 33010602011771号