代码复审实战
代码复审实战
0.前言
结对伙伴：顾舒婷
代码地址：Coding.net
1.部分代码示例
#include<stdio.h>
#include<stdlib.h>
#include<string.h>
#include<ctype.h>
void A();//A->V:=E
void E();//E->TE'
void T();//T->FT'
void E1();//E'->+TE'|-TE'|NULL
void T1();//T'->*FT'|/FT'|NULL
void F();//F->V|(E)
void V();//V->a|b|c|d....|z
char s[50],n='1';//s[50]”√”⁄¥Ê∑≈ ‰»Îµƒ∏≥÷µ±Ì¥Ô Ω
char Table[50][3]; //≤˙…˙÷–º‰¥˙¬ÎÀ˘–˵ƒ∑˚∫≈±Ì
int SIGN,sym;//symŒ™s[50]÷–µ±«∞∂¡»Î∑˚∫≈µƒœ¬±Í
int list_n=0;//∑˚∫≈±Ìµƒœ¬±Í
int main()
{
SIGN=0;
sym=0;
scanf("%s",&s);
if(s[0]=='\0')
return 0;
A();
if(s[sym]!='\0'&&SIGN==0)
{
printf("ERROR!\n");
exit(0);
}
return 0;
}
2.代码审查
| 功能模块名称 | 简单语法分析 |
|---|---|
| 审查人 | 张晓涛 |
| 审查日期 | 2018.4.5 |
| 代码名称 | 简单的语法分析.cpp |
| 代码作者 | 顾舒婷 |
| 文件结构 | |||
|---|---|---|---|
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 是 | ||
| 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 版权和版本声明是否完整？ | 否 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 否 | |
| 头文件中是否只存放“声明”而不存放“定义” | 是 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 是 | ||
| 代码行内的空格是否得体？ | 是 | ||
| 长行拆分是否得体？ | 是 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 否 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | |
| 标识符是否直观且可以拼读？ | 是 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ | 是 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | ||
| 是否编写太复杂或者多用途的复合表达式？ | 否 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | ||
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判 | |||
| 断移到循环体的外面？ | |||
| 重要 | Case语句的结尾是否忘了加break？ | ||
| 重要 | 是否忘记写switch的default分支？ | ||
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | ||
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | ||
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | |||
| 生存期内是常量，而对于整个类而言却是可变的。 | |||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
| 参数命名、顺序是否合理？ | 是 | ||
| 参数的个数是否太多？ | 否 | ||
| 是否使用类型和数目不确定的参数？ | 否 | ||
| 是否省略了函数返回值的类型？ | 否 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 否 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | ||
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | ||
| 重要 | 数组或指针的下标是否越界？ | 否 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | ||
| 重要 | 是否有效地处理了“内存耗尽”问题？ | ||
| 重要 | 是否修改“指向常量的指针”的内容？ | ||
| 重要 | 是否出现野指针？例如 | ||
| （1）指针变量没有被初始化; | |||
| （2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | |||
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | ||
| 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | ||
| 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | ||
| C++ 函数的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重载函数是否有二义性？ | 否 | ||
| 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | ||
| 运算符的重载是否符合制定的编程规范？ | |||
| 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 |
3.评价
我的结对伙伴代码的程序版式和常量的命名规则都很规范，表达式和基本语句也都做了处理，避免了太长，很便于理解。函数的设计也理解到位，递归思想也发挥的淋漓尽致，“码”如其人，也体现了这份代码的主人心思之细腻。注释也简洁精炼，虽然由于我们IDE不同导致了乱码，但也能看出能把常量和函数的功能总结成短短数字，反映了此程序员不拖沓，办事可靠的性格特点。更让我叹为观止的是该设计者定义了两个全局变量从而省去了函数的传参，整篇代码设计了7个函数，返回值全部为void，匠心独具，真可谓妙哉妙哉！
void A();//A->V:=E
void E();//E->TE'
void T();//T->FT'
void E1();//E'->+TE'|-TE'|NULL
void T1();//T'->*FT'|/FT'|NULL
void F();//F->V|(E)
void V();//V->a|b|c|d....|z
大到头文件引用，函数声明，小到变量赋值，数据的下角标，这已经不仅仅是能完成‘简单的语法分析’功能的一份代码了，更是一件艺术品，哦，不，艺术品只是有观赏性，应该用文物来形容，兼具观赏性的同时记录着匠人的心血，虽缺乏岁月的锤炼，但值得后世的程序猿敬仰并一代一代的传承。能有幸观摩并复审这份代码，实属在下的荣幸，如果非要鸡蛋里挑骨头的话，我也只能说函数名的定义可能过于简练，单用一个字母不便于理解函数的功能，但也可能是我无法理解大师的用心，如有冒犯，还望不吝赐教。
对了，忘了介绍我的结对伙伴，顾舒婷同学，为人随和，美丽大方，温柔善良，实乃居家旅行之……咳咳，有点跑题了，但总之不会有差。希望在今后的结对编程中也能得到顾同学的点拨，现在此谢过（手动膜拜表情）。
4.小结
这次结对编程，让我体会到了之前自己代码版式，命名的不规范，想要有一份别人能读懂的代码，就应该从细节入手，一步步完善，这样才能打好基础，有所进步。
