1、coding地址
该项目是由王翘楚所编写的数据结构课程设计--全国交通咨询模拟,该项目使用C/C++语言开发。
附coding地址:https://dev.tencent.com/u/CG160618/p/jiedui1/git
2、c++代码审查表
功能模块名称 | 全国交通咨询模拟 | ||
审查人 | 李俊颖 | 审查日期 | 2019/4/25 |
代码名称 | 全国交通咨询模拟.cpp | 代码作者 | 王翘楚 |
文件结构 | |||
重要性 | 审查项目 | 结论 | |
头文件和定义文件的名称是否合理? | √ | ||
头文件和定义文件的目录结构是否合理? | √ | ||
版权和版本声明是否完整? | × | ||
重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | × | |
头文件中是否只存放“声明”而不存放“定义”? | × | ||
程序版式 | |||
重要性 | 审查项目 | 结论 | |
代码段间的空行是否得体? | √ | ||
代码行内的空格是否得体? | × | ||
长行拆分是否得体? | × | ||
“{” 和 “}” 是否各占一行并且对齐于同一列? | × | ||
重要 | 一行代码是否只做一件事?如只定义一个变量,只写一条语句。 | × | |
重要 | If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 | × | |
重要 | 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名? | × | |
重要 | 注释是否清晰并且必要? | √ | |
重要 | 注释是否没有错误或者可能导致误解? | × | |
重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致? | 无类结构 | |
命名规则 | |||
重要性 | 审查项目 | 结论 | |
重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致? | √ | |
标识符是否直观且可以拼读? | √ | ||
标识符的长度应当符合“min-length && max-information”原则? | √ | ||
重要 | 程序中是否出现相同的局部变量和全部变量? | √ | |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? | √ | ||
静态变量、全局变量、类的成员变量是否加前缀? | √ | ||
表达式与基本语句 | |||
重要性 | 审查项目 | 结论 | |
重要 | 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? | × | |
是否未编写太复杂或者多用途的复合表达式? | × | ||
重要 | 是否未将复合表达式与“真正的数学表达式”混淆? | × | |
重要 | 是否用隐含错误的方式写if语句? 例如 | ||
1) 不将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | × | ||
2) 不将浮点变量用“==”或“!=”与任何数字比较。 | × | ||
3) 不将指针变量用“==”或“!=”与NULL比较。 | × | ||
如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判断移到断移到循环体的外面? | 无过大循环次数 | ||
重要 | Case语句的结尾是否忘了加break? | √ | |
重要 | 是否忘记写switch的default分支? | √ | |
重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化 | × | |
常量 | |||
重要性 | 审查项目 | 结论 | |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? | √ | ||
是否误解了类中的const数据成员?因为const数据成员只在某个对象 | × | ||
重要 | 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? | √ | |
生存期内是常量,而对于整个类而言却是可变的。 | √ | ||
函数设计 | |||
重要性 | 审查项目 | 结论 | |
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 | × | ||
参数命名、顺序是否合理? | √ | ||
参数的个数是否太多? | √ | ||
是否使用类型和数目不确定的参数? | × | ||
是否省略了函数返回值的类型? | × | ||
函数名字与返回值类型在语义上是否冲突? | × | ||
重要 | 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return返回。 | × | |
重要 | 在函数体的“入口处”,是否用assert对参数的有效性进行检查? | × | |
重要 | 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 | × | |
重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”? | √ | |
是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值, | × | ||
内存管理 | |||
重要性 | 审查项目 | 结论 | |
重要 | 用malloc或new申请内存之后,是否立即检查指针值是否为NULL? | 无申请 | |
重要 | 是否忘记为数组和动态内存赋初值? | × | |
重要 | 数组或指针的下标是否越界? | × | |
重要 | 动态内存的申请与释放是否配对? | 无申请和释放 | |
重要 | 是否有效地处理了“内存耗尽”问题? | × | |
重要 | 是否修改“指向常量的指针”的内容? | √ | |
重要 | 是否出现野指针?例如 | ||
1) 指针变量没有被初始化 | × | ||
2) 用free或delete释放了内存之后,忘记将指针设置为NULL。 | × | ||
重要 | 是否将malloc/free 和 new/delete 混淆使用? | 无此类语句 | |
重要 | malloc语句是否正确无误?例如字节数是否正确?类型转换是否正确? | 无malloc语句 | |
重要 | 在创建与释放动态对象数组时,new/delete的语句是否正确无误? | 无new/delete语句 | |
其它常见问题 | |||
重要性 | 审查项目 | 结论 | |
重要 | 数据类型问题: | ||
1) 变量的数据类型有错误吗? | × | ||
2) 存在不同数据类型的赋值吗? | × | ||
3) 存在不同数据类型的比较吗? | × | ||
重要 | 变量值问题: | ||
1) 变量的初始化或缺省值有错误吗? | × | ||
2) 变量发生上溢或下溢吗? | × | ||
3) 变量的精度够吗? | × | ||
重要 | 逻辑判断问题: | ||
1) 由于精度原因导致比较无效吗? | × | ||
2) 表达式中的优先级有误吗? | × | ||
3) 逻辑判断结果颠倒吗? | × | ||
重要 | 循环问题: | ||
1) 循环终止条件不正确吗? | × | ||
2) 无法正常终止(死循环)吗? | × | ||
3) 错误地修改循环变量吗? | × | ||
4) 存在误差累积吗? | × | ||
重要 | 错误处理问题: | ||
1) 忘记进行错误处理吗? | × | ||
2) 错误处理程序块一直没有机会被运行? | × | ||
3) 错误处理程序块本身就有毛病吗? | × | ||
4) 错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | × | ||
重要 | 文件I/O问题: | 无文件 | |
1) 对不存在的或者错误的文件进行操作吗? | |||
2) 文件以不正确的方式打开吗? | |||
3) 文件结束判断不正确吗? | |||
4) 没有正确地关闭文件吗? |
3、代码评价
王翘楚同学的这份代码从头文件就开始格式不规范让人看着很难过
# include<stdio.h>
#include<string.h>
#include<float.h>
到了switch语句这里顶格编写看了更加难受,Case语句的结尾还忘了加break,但是“{” 和 “}” 是否各占一行并且对齐于同一列这一点做的很好,而且还使用了goto语句,
switch(i) //switch语句
{
case 1:{ //第一种情况,修改地图
loop2:
printf("\t现有城市:\n\t\t");
for(j=0;j<cn;j++)
printf("%d.%s\t",j+1,city[j]);
printf("\n\n");
printf("\t\t功能:\n\t\t 1:添加 2:删除 3:返回\n");
printf("\t\t请选择:");
scanf("%d",&j);
while(j!=1&&j!=2&&j!=3)
{
printf("\t\t输入有误,请重新输入:");
scanf("%d",&j);
} //避免按错而导致程序错误
printf("\n");
if(j==1)
{
printf("\t请输入城市名:");
scanf("%s",city[cn]);
cn++;
goto loop2;
} //if语句
if(j==2)
{
printf("\t请选择要删除的城市的编号:");
scanf("%d",&k);
while(k>cn||k<1)
{
printf("\t\t输入有误,请重新输入:");
scanf("%d",&k);
} //避免按错而导致程序错误
if(k==cn) cn--;
else
{
for(m=k-1;m<cn-1;m++)
strcpy(city[m],city[m+1]); //k后面的城市依次往前移一位
cn--; //城市总数减少一个
}
goto loop2; //查看修改后的地图,便于判断或是再次修改
}
else goto loop1; //回到主菜单
}
其次还有的就是for嵌套不加 “{}”
for(i=0;i<cn;i++)
for(j=0;j<cn;j++)
{
edge[i][j]=max;
}
总体来说,这份代码代码结构基本工整,命名符合要求但是略复杂,表达格式基本不存在错误,注释简洁易懂,基本上不存在严重问题。