zoukankan      html  css  js  c++  java
  • 软件工程第四次作业

    代码复审

    队友源码地址

    C++代码审查表

    功能模块名称词法分析子程序
    审查人王松审查日期2018.4.5
    代码名称词法分析器代码作者姚晶华
    文件结构
    重要性 审查项结论
    头文件和定义文件的名称是否合理?
     头文件和定义文件的目录结构是否合理?
     版权和版本声明是否完整?
    重要头文件是否使用了 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 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。
       
    常量
    重要性 审查项结论
     是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串?
     在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++ 函数的高级特性
    重要性 审查项结论
     重载函数是否有二义性?
    重要是否混淆了成员函数的重载、覆盖与隐藏?
     运算符的重载是否符合制定的编程规范?
     是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。
    重要是否用内联函数取代了宏代码?
       
    类的构造函数、析构函数和赋值函数
    重要性 审查项结论
    重要是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数: 
     (1)缺省的无参数构造函数;
     (2)缺省的拷贝构造函数;
     (3)缺省的析构函数;
     (4)缺省的赋值函数。
    重要构造函数中是否遗漏了某些初始化工作?
    重要是否正确地使用构造函数的初始化表?
    重要析构函数中是否遗漏了某些清除工作?
     是否错写、错用了拷贝构造函数和赋值函数?
    重要赋值函数一般分四个步骤: 
     (1)检查自赋值;
     (2)释放原有内存资源;
     (3)分配新的内存资源,并复制内容;
     (4)返回 *this。是否遗漏了重要步骤?
    重要是否正确地编写了派生类的构造函数、析构函数、赋值函数? 
     注意事项: 
     (1)派生类不可能继承基类的构造函数、析构函数、赋值函数。
     (2)派生类的构造函数应在其初始化表里调用基类的构造函数。
     (3)基类与派生类的析构函数应该为虚(即加virtual关键字)。
     (4)在编写派生类的赋值函数时,注意不要忘记对基类的数据成员重新赋值
       
    类的高级特性
    重要性 审查项结论
    重要是否违背了继承和组合的规则? 
     (1)若在逻辑上B是A的“一种”,并且A的所有功能和属性对B而言都有意义,则允许B继承A的功能和属性。
     (2)若在逻辑上A是B的“一部分”(a part of),则不允许B从A派生,而是要用A和其它东西组合出B。
       
    其它常见问题
    重要性 审查项结论
    重要数据类型问题: 
     (1)变量的数据类型有错误吗?
     (2)存在不同数据类型的赋值吗?
     (3)存在不同数据类型的比较吗?
    重要变量值问题: 
     (1)变量的初始化或缺省值有错误吗?
     (2)变量发生上溢或下溢吗?
     (3)变量的精度够吗?
    重要逻辑判断问题: 
     (1)由于精度原因导致比较无效吗?
     (2)表达式中的优先级有误吗?
     (3)逻辑判断结果颠倒吗?
    重要循环问题: 
     (1)循环终止条件不正确吗?
     (2)无法正常终止(死循环)吗?
     (3)错误地修改循环变量吗?
     (4)存在误差累积吗?
    重要错误处理问题: 
     (1)忘记进行错误处理吗?
     (2)错误处理程序块一直没有机会被运行?
     (3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。
     (4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。
    重要文件I/O问题: 
     (1)对不存在的或者错误的文件进行操作吗?
     (2)文件以不正确的方式打开吗?
     (3)文件结束判断不正确吗?
     (4)没有正确地关闭文件吗?
       
    ###总结评价
    这是上学期的编译原理第一次实验的词法分析程序,顾名思义词法分析(英语:lexical analysis)是计算机科学中将字符序列转换为单词(Token)序列的过程。进行词法分析的程序或者函数叫作词法分析器(Lexical analyzer,简称Lexer),也叫扫描器(Scanner)。词法分析器一般以函数的形式存在,供语法分析器调用。 词法分析阶段是编译过程的第一个阶段,是编译的基础。这个阶段的任务是从左到右一个字符一个字符地读入源程序,即对构成源程序的字符流进行扫描然后根据构词规则识别单词(也称单词符号或符号)。词法分析程序实现这个任务。词法分析程序可以使用Lex等工具自动生成。 词法分析是编译程序的第一个阶段且是必要阶段;词法分析的核心任务是扫描、识别单词且对识别出的单词给出定性、定长的处理;实现词法分析程序的常用途径:自动生成,手工生成。除此以外,词法分析的第一阶段即扫描器,通常基于有限状态自动机。扫描器能够识别其所能处理的标记中可能包含的所有字符序列(单个这样的字符序列即前面所说的“语素”)。例如“整数”标记可以包含所有数字字符序列。很多情况下,根据第一个非空白字符便可以推导出该标记的类型,于是便可逐个处理之后的字符,直到出现不属于该类型标记字符集中的字符(即最长一致原则)。 词法分析器的工作是低级别的分析:将字符或者字符序列转化成记号。在谈论词法分析时,使用术语“词法记号”(简称记号)、“模式”和“词法单元”表示特定的含义。 在分析时,一是把词法分析器当成语法分析的一部分,另一种是把词法分析器当成编译程序的独立部分。在前一种情况下,词法分析器不断地被语法分析器调用,每调用一次词法分析器将从源程序的字符序列拼出一个单词,并将其Token值返回给语法分析器。后一种情况则不同,词法分析器不是被语法分析器不断地调用,而是一次扫描全部单词完成编译器的独立一遍任务。词法分析器的设计与实现程序的输入与预处理步骤: 输入缓冲区 成对且对半互补的输入缓冲区模式。 n: 取2的整次幂;每个半区的末尾设置标志“ eof ” 表示读入该半区的源程序的结束; B:单词w开始指针; F:扫描w的指针。 两个缓冲区的输入模式 预处理程序: (作用) 1) 减少内存空间占用; 2) 减轻扫描器实质性处理的负担; 预处理程序主要任务: 1) 滤掉源程序中的非单词成分(如无用空格;换行符等); 2) 其他的预处理工作:滤掉注释;宏替换;文件包含的嵌入;条件编译的嵌入。 词法解析器在编译器中的作用,是将输入流解析为一种能够被语法解析器使用和管理的格式。他将输入文本分割,打标签,也就是用一些数值来指代一系列相应的字符串,例如关键字while 可以和一个标签关联起来,一般情况下,一个标签可以和很多字符串关联,例如以前看到的NUM_OR_ID,它指代的是代码中的变量定义和数字常量,显然,他们是无穷的, 词法解析器还可以将源码中的注释剔除,忽略空格,换行符等,将这些琐事的工作从语法解析中剥离出来,简化语法解析器的设计。 最后,再总结一下队友的编程风格是值得提倡的,也非常值得我学习,虽然有一些没有审查到的地方和一些变量命名等方面的不足,这些其实也是值得我注意的和改进的!!!
  • 相关阅读:
    MySQL 存储过程
    linux iptables 相关设置
    Ubuntu iptables 设置
    Mac OS 10.12
    解决:cc1.exe: sorry, unimplemented: 64-bit mode not compiled in
    go get golang.org/x/net 安装失败的解决方法!
    Ubuntu16.04
    Ubuntu16.04
    Ubuntu16.04
    在Ubuntu16.04里面安装Gogland!
  • 原文地址:https://www.cnblogs.com/wang-song/p/8724321.html
Copyright © 2011-2022 走看看