词法分析器代码复审
Posted lichaoshuai
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了词法分析器代码复审相关的知识，希望对你有一定的参考价值。
1.任务要求
??·对同伴的作品进行代码复审，将对伙伴审查的结果以表格的形式博客中。
2.代码简介
??·此次博客审查的代码由李云辉同学编写，项目名称为：词法分析器，代码目的是将计算机科学中字符序列转换为单词序列，供语法分析器调用。
3.代码地址
4.项目代码
//
// main.cpp
// cffxq
//
// Created by LiYuNhUi on 2018/4/8.
// Copyright ? 2018年 LiYuNhUi. All rights reserved.
//
#include "stdlib.h"
#include "stdio.h"
#include "string.h"
#include <iostream>
using namespace std;
static char reserveWord[32][20] = {
"auto", "break", "case", "char","const","continue","default","do",
"double", "else", "enum", "extern", "float", "for", "goto", "if",
"int", "long", "register", "return", "short", "signed", "sizeof", "static",
"struct", "switch", "typedef", "union", "unsigned", "void","volatile", "while"
};
static char operatorOrDelimiter[37][10] = {
"+", "-", "*", "/", "<", "<=", ">", ">=", "=", "==",
"!=", ";", "(", ")", "^", ",", "\"", "\'", "#", "&",
"&&", "|", "||", "%", "~", "<<", ">>", "[", "]", "{",
"}", "\\", ".", "\?", ":", "!","\n"
};
int searchReserveword(char reserveWord[][20], char s[]){
int i=0;
for (i=0; i<32; i++){
if (strcmp(reserveWord[i], s)==0) {
return i+1;
}//if
}//for
return -1;
}// 识别保留字
bool Letters (char letter){
if((letter>='a'&&letter<='z')||(letter>='A'&&letter<='Z')||letter=='-')return true;
else return false;
}//识别字母
bool Digit (char digit){
if(digit>='0'&&digit<='9') return true;
else return false;
}//识别数字
int cleanproject(char r[],int pnum){
int i=0, count=0;
char clean[1000];
while (i<pnum) {
if(r[i]=='/'&&r[i+1]=='/'){
while (r[i]!='\n') {
i++;
}//while
}//跳过单行注释
if (r[i]=='/'&&r[i+1]=='*') {
while (!(r[i]=='*'&&r[i+1]=='/')) {
i++;
}//while
i+=2;
}//跳过多行注释
if (r[i]!='\r'&&r[i]!='\t') {
clean[count++]=r[i];
}
i++;
}//while
clean[count]='\0';
strcpy(r, clean);
return count;
}
void analysis(char project[], char take[], int &flag, int &pnum ){
int i=0;
int count=0;
for (i=0; i<20; i++) {
take[i]='\0';
}
while(project[pnum]==' ') {
pnum++;
}
if (Letters(project[pnum])) {
take[count++]=project[pnum];
pnum++;
while(Letters(project[pnum])||Digit(project[pnum])){
take[count++]=project[pnum];
pnum++;
}
take[count]='\0';
flag=searchReserveword(reserveWord, take);
if (flag==-1) {
flag=100;
}
return;
}
else if (Digit(project[pnum])) {
take[count++]=project[pnum];
pnum++;
while (Digit(project[pnum])) {
take[count++]=project[pnum];
pnum++;
}
take[count]='\0';
flag=99;
return;
}
else if(project[pnum]=='+'||project[pnum]=='-'||project[pnum]=='*'||project[pnum]=='/'||project[pnum]=='('||project[pnum]==')'||project[pnum]=='['||project[pnum]==']'||project[pnum]=='{'||project[pnum]=='}'||project[pnum]==';'||project[pnum]==','||project[pnum]=='\n'){
take[count++]=project[pnum];
pnum++;
take[count]='\0';
i=0;
while (i<36) {
if(strcmp(take, operatorOrDelimiter[i])==0){
flag=i+33;
return ;
}
i++;
}
}
else if(project[pnum]=='='){
take[count++]=project[pnum];
if (project[++pnum]=='=') {
take[count++]=project[pnum];
take[count]='\0';
flag=41;
return;
}
else {
flag=42;
}
}
else if(project[pnum]=='<'){
take[count++]=project[pnum];
if (project[++pnum]=='=') {
take[count++]=project[pnum];
take[count]='\0';
flag=38;
return;
}
else {
flag=37;
}
}
else if(project[pnum]=='>'){
take[count++]=project[pnum];
if (project[++pnum]=='=') {
take[count++]=project[pnum];
take[count]='\0';
flag=40;
return;
}
else {
flag=39;
}
}
}
int main(int argc, const char * argv[]) {
char project[1000];
char take[20];
int pnum=0;
int length=0;
int flag=0;
project[length]=getchar();
while (project[length]!='#') {
project[++length]=getchar();
}
pnum=0;
length=cleanproject(project, length);
int i=0;
while (i<length){
cout<<project[i];
i++;
}
cout<<'\n';
while(pnum<length){
analysis(project, take, flag, pnum);
if (flag<=32&&flag>=1) {
printf("<%d, ->",flag);
}
else if(flag==99){
printf("<%d, %s>",flag, take);
}
else if(flag==100){
printf("<%d, %s>",flag, take);
}
else{
if (flag==69) {
printf("\n");
}
else printf("<%d, %s>",flag, take);
}
}
return 0;
}
5.代码审查表
| 功能模块名称 | 词法分析器 | ||
| 审查人 | 李朝帅 | 审查日期 | 2019/4/23 |
| 代码名称 | 词法分析 | 代码作者 | 李云辉 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 不完整 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 未使用 | |
| 头文件中是否只存放“声明”而不存放“定义” | 否 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 是 | ||
| 代码行内的空格是否得体？ | 是 | ||
| 长行拆分是否得体？ | 是 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 否 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 否 | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？ | 是 | |
| 注释是否清晰并且必要？ | 否 | ||
| 重要 | 注释是否有错误或者可能导致误解？ | 否 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 无类结构 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 一致 | |
| 标识符是否直观且可以拼读？ | 是 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ |
未应用类似标识符 |
||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 是 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 | |
| 是否编写太复杂或者多用途的复合表达式？ | 是 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | ||
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ | 是 | ||
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 | |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象生存期内是常量，而对于整个类而言却是可变的。 | 否 | ||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
| 参数命名、顺序是否合理？ | 是 | ||
| 参数的个数是否太多？ | 是 | ||
| 是否使用类型和数目不确定的参数？ | 否 | ||
| 是否省略了函数返回值的类型？ | 否 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 否 | |
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 是 | |
| 重要 | 数组或指针的下标是否越界？ | 否 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 否 | |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 否 | |
| 重要 | 是否修改“指向常量的指针”的内容？ | 否 | |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 否 | |
| 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。 | 否 | ||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 否 | ||
| （２）存在不同数据类型的赋值吗？ | 否 | ||
| （３）存在不同数据类型的比较吗？ | 否 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 否 | ||
| （２）变量发生上溢或下溢吗？ | 未发生 | ||
| （３）变量的精度够吗？ | 足够 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 否 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 否 | ||
| （２）无法正常终止（死循环）吗？ | 否 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 不存在 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 否 | ||
| （２）错误处理程序块一直没有机会被运行？ | 否 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 否 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 否 | ||
| 重要 | 文件I/O问题： | 未应用 | |
6.代码分析
·代码评价
??词法分析是计算机科学中将字符序列转换为单词序列的过程，也叫扫描器，是进行下一步计算机编译的基础。在词法分析器的编写过程中虽然并没有过多过难的设计和算法，但对程序设计者的整体程序设计能力、各功能函数的设计和应用、模块功能的实现层次及编程时的耐心和细心都有着很大的考验。李云辉同学在这方面做的很好，在自动单元测试的环节中通过所有预先设定好的测试样例，在程序的细节把控上较为完美。从此词法分析器整体来看，数据结构设置合理且全面，应用充分，函数层次分明，各功能模块可以实现相互配合实现的代码的更优化。
??·代码亮点
????·函数层次分明，易于审查及维护；
????·代码工整，各变量设置妥当；
????·充分考虑词法分析时的各种情况，做到no warning，no error。
??·代码缺陷
????·函数名定义不规范，有些函数名定义过于随意；
????·版权和版本声明不完整；
????·少数函数编写的啰嗦，对代码执行速率的考虑不够周全；
????·存在一些部分，代码书写格式不规范。
?? ·改进意见
????·希望代码作者可以在代码具体书写的能力上多做一些加强;
????·在函数命名和函数结构设计上，我们都应该多看一些他人的技术博客，多多学习；
????·代码作者可以进一步优化代码，省去一些不必要的判断，加快代码执行速率。
7.心得体会
??·对其他同学的代码审查也是对自己的考验，在细心发现他人代码缺陷的同时也是对自己编程能力的更严苛要求，第一次结伴作业受益良多。
以上是关于词法分析器代码复审的主要内容，如果未能解决你的问题，请参考以下文章