软工作业——团队作业2.2

代码规范

一.命名规范

  • 1.每个变量名都按照所起的作用来命名,不随意命名。例如,分数就用grade来命名而不是a,b,c之类的

  • 2.根据现在通用的命名规则来进行命名变量,常量,函数之类的,方便阅读

  • 3.不要出现全局变量和局部变量名一样,会造成误解,尽管作用域不一样,但阅读时可能会造成误解

  • 4.变量名的长度不要超过20个字符,但也不能太少,能写全称就写全称,不要写缩写,方便阅读

  • 5.命名时尽量使用英文描述,不要使用拼音中文等其他描述方式

  • 6.如果在不同类或者函数里面出现相同的变量名,使用下划线来加上这个变量名的作用范围,以便阅读

  • 7.尽量不要使用数字编号,如的确有需要,可以通过下划线的方式来加编号,例如num_1 这样,不要num1

二.设计规范

  • 1.采用模块化设计,通过一个个功能模块相结合来实现功能,不要把所有实现的功能全部写在一个模块里面

  • 2.每个模块或者函数里面,只实现一个所需要的功能,最重要的原则就是:只做一件事,并且做好

  • 3.在设计时,在需要说明的地方或者比较难理解的地方,写好注释,方便小组其他成员阅读

  • 4.在适当的地方进行错误处理,使得程序在出现错误了可以及时反馈出来且不造成程序停止

  • 5.采用多文件结构,把各个功能模块可以写在不同文件里面,方便修改阅读等。

三.代码书写规范

  • 1.不在一行写太多东西,尽量一行只执行一个功能,不要执行多个。

  • 2.在缩进时,不要实验tab键,用空格就好,一般是缩进4个空格

  • 3.对于传过来的参数要进行参数验证,看是否传过来的是正确参数

  • 4.对于一个式子里面出现多个优先级不同的运算符时,用括号括起来说明优先级情况,这样方便阅读理解

数据库设计

ER图

功能流程描述

小组成员分工

猜你喜欢

转载自www.cnblogs.com/piwei/p/9194777.html