软件工程第一次结对作业2

代码地址：

https://git.dev.tencent.com/zhangxuexin/SyntaxAnalyzer.git

代码审核表：

功能模块名称	语法分析器
审查人	顾苡铭	审查日期	2019.4.22
代码名称	语法分析器	代码作者	张学鑫
文件结构
序号	审查项	结论	重要性
1	头文件和定义文件的名称是否合理？	是
2	头文件和定义文件的目录结构是否合理？	是
3	版权和版本声明是否完整？	不完整
4	头文件是否使用了 ifndef/define/endif 预处理块?	否	重要
5	头文件中是否只存放“声明”而不存放“定义”	是
程序的版式
序号	审查项	结论	重要性
1	空行是否得体？	是
2	代码行内的空格是否得体？	是
3	长行拆分是否得体？	是
4	“{” 和 “}” 是否各占一行并且对齐于同一列？	是
5	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	是	重要
6	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	是	重要
7	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	是	重要
8	注释是否有错误或者可能导致误解？	否	重要
9	类结构的public, protected, private顺序是否在所有的程序中保持一致？	是	重要
命名规则
序号	审查项	结论	重要性
1	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是	重要
2	标识符是否直观且可以拼读？	是
3	标识符的长度应当符合“min-length && max-information”原则？	是
4	程序中是否出现相同的局部变量和全部变量？	是	重要
5	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是
6	静态变量、全局变量、类的成员变量是否加前缀？	是
表达式与基本语句
序号	审查项	结论	重要性
1	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	是	重要
2	是否编写太复杂或者多用途的复合表达式？	是
3	是否将复合表达式与“真正的数学表达式”混淆？	是	重要
4	是否用隐含错误的方式写if语句? 例如		重要
	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	是
	（2）将浮点变量用“==”或“！=”与任何数字比较。	是
	（3）将指针变量用“==”或“！=”与NULL比较。	是
5	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判	是
6	断移到循环体的外面？	是
7	Case语句的结尾是否忘了加break？	否	重要
8	是否忘记写switch的default分支？	否	重要
9	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	否	重要
常量
序号	审查项	结论	重要性
1	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是
2	在C++ 程序中，是否用const常量取代宏常量？	是
3	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	是	重要
4	是否误解了类中的const数据成员？因为const数据成员只在某个对象	是
5	生存期内是常量，而对于整个类而言却是可变的。	是
函数设计
序号	审查项	结论	重要性
1	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
2	参数命名、顺序是否合理？	是
3	参数的个数是否太多？	是
4	是否使用类型和数目不确定的参数？	是
5	是否省略了函数返回值的类型？	否
6	函数名字与返回值类型在语义上是否冲突？	否
7	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	是	重要
8	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	是	重要
9	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	否	重要
10	return语句是否返回指向“栈内存”的“指针”或者“引用”？	是	重要
11	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	否
内存管理
序号	审查项	结论	重要性
1	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）	是	重要
2	是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	否	重要
3	数组或指针的下标是否越界？	否	重要
4	动态内存的申请与释放是否配对？（防止内存泄漏）	否	重要
5	是否有效地处理了“内存耗尽”问题？	是	重要
6	是否修改“指向常量的指针”的内容？	是	重要
7	是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。	是	重要
8	是否将malloc/free 和 new/delete 混淆使用？	否	重要
9	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	是	重要
10	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	的	重要
C++ 函数的高级特性
序号	审查项	结论	重要性
1	重载函数是否有二义性？	是
2	是否混淆了成员函数的重载、覆盖与隐藏？	是	重要
3	运算符的重载是否符合制定的编程规范？	的
4	是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。	否
5	是否用内联函数取代了宏代码？	否	重要
类的构造函数、析构函数和赋值函数
序号	审查项	结论	重要性
1	是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数：		重要
	（1）缺省的无参数构造函数；	否
	（2）缺省的拷贝构造函数；	否
	（3）缺省的析构函数；	否
	（4）缺省的赋值函数。	否
2	构造函数中是否遗漏了某些初始化工作？	否	重要
3	是否正确地使用构造函数的初始化表？	是	重要
4	析构函数中是否遗漏了某些清除工作？	否	重要
5	是否错写、错用了拷贝构造函数和赋值函数？	否
6	赋值函数一般分四个步骤：	否	重要
	（1）检查自赋值；	否
	（2）释放原有内存资源；	否
	（3）分配新的内存资源，并复制内容；	否
	（4）返回 *this。是否遗漏了重要步骤？	否
6	是否正确地编写了派生类的构造函数、析构函数、赋值函数？	是	重要
7	注意事项：
	（1）派生类不可能继承基类的构造函数、析构函数、赋值函数。	无
	（2）派生类的构造函数应在其初始化表里调用基类的构造函数。	无
	（3）基类与派生类的析构函数应该为虚（即加virtual关键字）。	无
	（4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值	无
类的高级特性
序号	审查项	结论	重要性
1	是否违背了继承和组合的规则？	否	重要
	（1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。	否
	（2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。	否
其它常见问题
序号	审查项	结论	重要性
1	数据类型问题：		重要
	（１）变量的数据类型有错误吗？	无
	（２）存在不同数据类型的赋值吗？	是
	（３）存在不同数据类型的比较吗？	是
2	变量值问题：		重要
	（１）变量的初始化或缺省值有错误吗？	无
	（２）变量发生上溢或下溢吗？	否
	（３）变量的精度够吗？	是
3	逻辑判断问题：		重要
	（１）由于精度原因导致比较无效吗？	否
	（２）表达式中的优先级有误吗？	否
	（３）逻辑判断结果颠倒吗？	否
4	循环问题：		重要
	（１）循环终止条件不正确吗？	否
	（２）无法正常终止（死循环）吗？	否
	（３）错误地修改循环变量吗？	否
	（４）存在误差累积吗？	否
5	错误处理问题：		重要
	（１）忘记进行错误处理吗？	否
	（２）错误处理程序块一直没有机会被运行？	否
	（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	否
	（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。	否
6	文件I/O问题：		重要
	（１）对不存在的或者错误的文件进行操作吗？	否
	（２）文件以不正确的方式打开吗？	否
	（３）文件结束判断不正确吗？	否
	（４）没有正确地关闭文件吗?	否

代码评价

张学鑫同学的这个代码是关于语法分析器的一个程序。在问题分析中我们介绍到用文法表来进行归约，文法表graTable是一个二维数组，保存文法中算符的种别码。归约的时候，只要最左素短语的种别码匹配到文法表中的某一项，就可以按照那个归约操作来进行归约。归约的步骤参照流程图中的操作，设置栈顶指针，将栈顶结点的种别码设为非终结符，并且还要保存这一次归约产生的结果。举个例子，比如E->E+T 这次归约，E+T会产生一个结果，这个结果最终就保存在栈顶结点的数值域中。需要注意的是，Node结点中数值域的主要作用就是在归约中保存结果。当有句子要进行处理时，首先要对其进行词法分析来分解出该句子中的每个符号，然后将该句子按照算符优先算法压入归约栈中，如果可以顺利归约，则说明这是一个合法的句子，否则该句子非法。这里有一个需要考虑的地方，就是如何进行归约。由于文法已经给定，所以我们考虑设计一个文法表，文法表中的内容就是可归约串的种别码的顺序，比如v=E可以表示为9,1,13。这样的话当我们要进行一次归约时，只用按顺序存储最左素短语中符号的种别码，然后拿这个种别码序列与文法表进行匹配，就可知道当前归约需要执行哪些操作。还有一点需要注意，就是如何对一个表达式进行求值。这里需要我们设计一个二元组的变量名表，这个变量名表可以根据变量的名称来返回变量的数据。变量名表的具体设计见详细设计部分。由于是简化分析，所以这个程序只考虑整数的处理。变量名表varTable的作用是根据变量名来返回该变量的数值，是一个二元组的序列，为了方便这里采用STL模板中的map来实现。变量名表的主要用处也就是在赋值语句和表达式求值当中，比如说当有赋值语句a=5需要归约时，检查变量a是否存在于变量名表中，如果不存在就将a和5添加至变量名表，如果a存在那么就可以更新变量名表中a的数值。并且在有F->v这样的归约中，如果查找到v不在变量名表中，说明v就是一个未赋值的变量，这样就产生异常。由于真正要设计一个栈来处理问题有些麻烦，所以这里可以用一个数组s[]来代替栈，如图2.1所示，i就代表栈顶指针，s[i]就代表栈顶的元素。归约栈中的结点，构造一个数据结构Node来表示，Node中有三个元素，算符的单词名str、算符的种别码type、算符的数值num。当我们词法分析来扫描出一个单词的时候，就可以填充Node结点的单词名、种别码和数值。其中他的判断框架如下：

样例输入（输入来自文件in.txt）：
　　a = 5
　　b = a + 10
　　b?
　　b + a * a?
　　a = (a + b) * (b - a) + 5 + 4 / 2
　　a?
　　clear
　　ab =

样例输出（输出至文件out.txt）：
　　a = 5 为合法句子，执行成功
　　b = a + 10 为合法句子，执行成功
　　b? 为合法句子，执行成功
　　b 的值为 15
　　b + a * a? 为合法句子，执行成功
　　b + a * a 的值为 40
　　a = (a + b) * (b - a) + 5 + 4 / 2 为合法句子，执行成功
　　a? 为合法句子，执行成功
　　a 的值为 207
　　clear 为合法句子，执行成功
　　ab =  语句出现语法错误！

优点：排版整齐，注释详细
缺点：代码逻辑略有混乱，思路不是很清楚