团队作业(三):确定分工
需求规格说明书更改情况
加入了“单位”这一角色,并构思了其页面设计和权限分配,修改后的版本已上传
https://gitee.com/Shady545/gongwen/blob/master/需求规格说明书(改).pdf
代码规范和编码原则
一、代码规范
1.风格规范
原则:简明、易读、无二义性
(1)空行
空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰,空行不会浪费内存。
规则一:定义变量后要空行。
尽可能在定义变量的同时初始化该变量,即遵循就近原则。如果变量的引用和定义相隔比较远,那么变量的初始化就很容易被忘记。若引用了未被初始化的变量,就会导致程序出错。
规则二:每个函数定义结束之后都要加空行。
总规则:两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰。
(2)空格
规则一:关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(,以突出关键字。
规则二:函数名之后不要留空格,应紧跟左括号(,以与关键字区别。
规则三:(向后紧跟;)、,、;这三个向前紧跟;紧跟处不留空格。
规则四:,之后要留空格。如果;不是一行的结束符号,其后要留空格。
规则五:赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =、==、!=、+=、-=、*=、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、 等双目运算符的前后应当加空格。
注意,运算符“%”是求余运算符,与 printf 中 %d 的“%”不同,所以 %d 中的“%”前后不用加空格。
规则六:单目运算符 !、~、++、--、-、*、& 等前后不加空格。
(3)成对书写
成对的符号一定要前后呼应,尤其是程序涉及多层嵌套的时候;
(4)缩进
缩进是通过键盘上的 Tab 键实现的,缩进可以使程序更有层次感。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。
(5)对齐
对齐主要是针对大括号{}说的:
规则一:{和}分别都要独占一行。互为一对的{和}要位于同一列,并且与引用它们的语句左对齐。
规则二:{}之内的代码要向内缩进一个 Tab,且同一地位的要左对齐,地位不同的继续缩进。
还有需要注意的是,很多编程软件是会“自动对齐”的,比如:
(6)代码行
规则一:一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。
规则二:if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有也要加{},并且遵循对齐的原则,这样可以防止书写失误。
(7)注释
“注释(包括所有源代码)应该只用ASCLL字符,不要使用中文和其他字符,否则会极大影响程序的可植性”
2. 设计规范
(1)函数:只做一件事,做好一件事;
(2)goto:可使用goto实现函数的单一出口(但也要尽量少使用),助于程序逻辑的清晰体现
(3)错误处理:参数处理、断言。4、运算符:一般情况下不需要自定义操作符,运算符不要做标准语义以外的任何动作。运算符的实现必须非常有效率,如有复杂的操作,应定义一个单独的函数;
3.代码复审
在“代码规范”的框架内正确解决问题(自我复审、同伴复审、团队复审),最基本的复审手段是同伴复审。复审的目的:找出代码的错误、发现逻辑错误、发现算法错误、发现潜在的错误和回归性错误、发现可能改进的地方、教育传授经验给开发人员
二、编码原则
1.函数编写原则
函数的规模尽量限制在 200 行以内,一个函数仅完成一件功能,为简单功能编写函数,函数的功能应该是可以预测的。
2.指针、数组、字符串编写规范
不管指针变量是全局的还是局部的、静态的还是非静态的,应当在声明它的同时初始化 它,要么赋子NULL。当把“&”用于指针时,就是在提取变量的地址。不能在一个指针前面连续使用多个“&”。
数据库设计
后端架构设计
任务确定
任务分配情况
- 徐源:任务统筹和后台架构设计
- 杨淑钰:数据库设计
- 孙菲遥:代码规范和编码原则
- 蒋进:确定新加入的功能和修改需求规格说明书
- 李兴昕:代码仓库维护和生成燃尽图
- 石志涛:WSB图