wordcount功能实现和单元测试
Github网址:https://gitee.com/ronanly/WordCount.git
1.思路
看到题目时,对于编写wordcount这个项目,首先想到它应该实现的功能有哪些,再来细化这些功能;
我用的C语言,然后用gcc编译器来执行,在我的代码里,有以下功能实现函数:
1.void countc(char *file) //返回文件的字符数
2.void countw(char *file)//返回文件词的数目
3.void countl(char *file) //返回文件的行数
4.void count_blankline(char *file) //返回文件的空行数
5.void count_noteline(char *file) //返回文件的注释行数
6.void count_codeline(char *file)//返回文件的代码行数
7.void searchfile() //寻找文件夹中的txt文件
8.saveFile(char *fileName,char* feature,int num)//存储到指定文件中
1.1 WordCount需求说明
WordCount的需求可以概括为:对程序设计语言源文件统计字符数、单词数、行数,统计结果以指定格式输出到默认文件中,以及其他扩展功能,并能够快速地处理多个文件。
可执行程序命名为:wc.exe,该程序处理用户需求的模式为:
wc.exe [parameter] [input_file_name]
存储统计结果的文件默认为result.txt,放在与wc.exe相同的目录下。
1.2 基本功能
wc.exe -c file.c //返回文件 file.c 的字符数
wc.exe -w file.c //返回文件 file.c 的单词总数
wc.exe -l file.c //返回文件 file.c 的总行数
wc.exe -o outputFile.txt //将结果输出到指定文件outputFile.txt
注意:
空格,水平制表符,换行符,均算字符。
由空格或逗号分割开的都视为单词,且不做单词的有效性校验,例如:thi#,that视为用逗号隔开的2个单词。
-c, -w, -l参数可以共用同一个输入文件,形如:wc.exe –w –c file.c 。
-o 必须与文件名同时使用,且输出文件必须紧跟在-o参数后面,不允许单独使用-o参数。
1.3 扩展功能
wc.exe -s //递归处理目录下符合条件的文件
wc.exe -a file.c //返回更复杂的数据(代码行 / 空行 / 注释行)
wc.exe -e stopList.txt // 停用词表,统计文件单词总数时,不统计该表中的单词
[file_name]: 文件或目录名,可以处理一般通配符。
其中,
代码行:本行包括多于一个字符的代码。
空 行:本行全部是空格或格式控制字符,如果包括代码,则只有不超过一个可显示的字符,例如“{”。
注释行:本行不是代码行,并且本行包括注释。一个有趣的例子是有些程序员会在单字符后面加注释:
}//注释
在这种情况下,这一行属于注释行。
2.PSP开发耗时
PSP2.1 |
Personal Software Process Stages |
预估耗时(分钟) |
实际耗时(分钟) |
Planning |
计划 |
60 |
30 |
· Estimate |
· 估计这个任务需要多少时间 |
120 |
120 |
Development |
开发 |
60 |
60 |
· Analysis |
· 需求分析 (包括学习新技术) |
30 |
30 |
· Design Spec |
· 生成设计文档 |
30 |
30 |
· Design Review |
· 设计复审 (和同事审核设计文档) |
30 |
20 |
· Coding Standard |
· 代码规范 (为目前的开发制定合适的规范) |
30 |
30 |
· Design |
· 具体设计 |
30 |
20 |
· Coding |
· 具体编码 |
100 |
120 |
· Code Review |
· 代码复审 |
30 |
40 |
· Test |
· 测试(自我测试,修改代码,提交修改) |
60 |
80 |
Reporting |
报告 |
30 |
40 |
· Test Report |
· 测试报告 |
30 |
30 |
· Size Measurement |
· 计算工作量 |
30 |
30 |
· Postmortem & Process Improvement Plan |
· 事后总结, 并提出过程改进计划 |
30 |
30 |
合计 |
|
700 |
710 |
2.代码部分
2.1主函数:
1 int main(int argc,char *argv[]) 2 { 3 FILE *fp; 4 while(1) 5 { 6 if((fp=fopen(argv[2],"r"))==NULL) 7 { 8 printf("FileNull\n\n\n"); 9 scanf("%s%s%s",argv[0],argv[1],argv[2]); 10 continue; 11 } 12 else if(!strcmp(argv[1],"-w")) 13 countw(argv[2]); 14 else if(!strcmp(argv[1],"-c")) 15 countc(argv[2]); 16 else if(!strcmp(argv[1],"-l")) 17 countl(argv[2]); 18 else if(!strcmp(argv[1],"-a")) 19 { 20 count_blankline(argv[2]); 21 count_noteline(argv[2]); 22 count_codeline(argv[2]); 23 } 24 else if(!strcmp(argv[1],"-s")) 25 { 26 searchfile(); 27 } 28 else 29 printf("NullPoint\n"); 30 printf("\n\n"); 31 scanf("%s%s%s",argv[0],argv[1],argv[2]); 32 } 33 return 0; 34 }
输入指令分成三组,根据第二组的指令对第三组的指令文件名执行相应的操作。
2.2 基本功能:
(-c(返回文件的字符数),-s(寻找文件中的txt文件),-l( 返回文件的行数),-w(返回文件词的数目),-a(统计空行,代码行,注释行))
1 void countc(char *file) //返回文件的字符数 2 { 3 FILE *f; 4 f=fopen(file, "r");//打开读取文件 5 char a; 6 int cchar=0; 7 if(f==NULL)//文件为空或不存在 8 { 9 printf("file is NULL"); 10 } 11 else 12 while (!feof(f)) 13 { 14 a=fgetc(f);//从文件里获取字符数 15 if (a != ' '&&a != '\n'&&a != '\t') 16 cchar++; 17 } 18 fclose(f);printf("charnum:%d ",cchar);//文件关闭,返回文件的字符数 19 saveFile(file,a,num); 20 }
1 void countw(char *file)//返回文件词的数目 2 { 3 FILE *f; 4 f=fopen(file,"r"); 5 char ch; 6 int aword; 7 int cword=0; 8 if(f==NULL) 9 { 10 printf("file is NULL"); 11 } 12 else 13 while(!feof(f)) 14 { 15 ch=fgetc(f); 16 if((ch >= 'a'&&ch <= 'z')||(ch>='A'&&ch<='Z')||ch=='_') 17 aword=1; 18 else if (aword) 19 { 20 cword++; 21 aword=0; 22 } 23 } 24 fclose(f); 25 printf("wordnum:%d ",cword); 26 saveFile(file,a,cword); 27 }
1 void countl(char *file) //返回文件的行数 2 { FILE *f; 3 f = fopen(file, "r"); 4 int cline = 1; 5 char a; 6 if(f==NULL) 7 { 8 printf("file is NULL"); 9 } 10 else 11 while(!feof(f)) 12 { 13 a=fgetc(f); 14 if(a=='\n'||a=='\t') 15 cline++; 16 } 17 18 fclose(f); 19 printf("Linenum:%d ",cline); 20 saveFile(file,s,cline); 21 22 }
1 void count_blankline(char *file) //返回文件的空行数 2 { 3 FILE *f; 4 int b_num = 0;//空行数 5 int ch_num = 0;//字符个数 6 char ch; 7 f = fopen(file, "r"); 8 if(f==NULL) 9 { 10 printf("file is NULL"); 11 } 12 else 13 while (!feof(f)) 14 { 15 ch= fgetc(f); 16 if (ch=='\n') 17 { 18 if (ch_num<= 1)b_num++; 19 ch_num = 0; 20 } 21 else if (ch!=' '&&ch!='\t'&&ch!='}') 22 ch_num++; 23 else if(ch=='}') 24 b_num++; 25 } 26 fclose(f); 27 printf("blankline:%d ",b_num); 28 saveFile(file,a,b_num); 29 }
1 void count_noteline(char *file) //返回文件的注释行数 2 { 3 FILE *f; 4 int ch_num = 0; 5 int note_num=0; 6 char ch; 7 f=fopen(file, "r"); 8 if(f==NULL) 9 { 10 printf("file is NULL"); 11 } 12 else 13 while (!feof(f)) 14 { 15 ch= fgetc(f); 16 if(ch=='\n') 17 { 18 if(ch_num==2) note_num++; 19 ch_num=0; 20 } 21 else if(ch=='/') ch_num++; 22 else if(ch_num==1) 23 { 24 if(ch=='/') ch_num++; 25 } 26 } 27 fclose(f); 28 printf("noteline:%d ",note_num); 29 saveFile(file,a,note_num); 30 }
1 void count_codeline(char *file)//返回文件的代码行数 2 { 3 FILE *f; 4 int ch_num = 0; 5 int code_num=0; 6 int tag=0; 7 int flag=0; 8 char a; 9 f = fopen(file, "r"); 10 if(f==NULL) 11 { 12 printf("file is NULL"); 13 } 14 else 15 while (!feof(f)) 16 { 17 a=fgetc(f); 18 if(flag==2) 19 { 20 flag=0;tag++; 21 } 22 else 23 { 24 if(a=='\n'&&ch_num>1) 25 { 26 code_num++; 27 ch_num=0; 28 } 29 else if(a != ' '&&a != '\n'&&a != '\t'&&a!='/') 30 { 31 ch_num++; 32 } 33 else if(a=='/') 34 { flag++;} 35 } 36 } 37 fclose(f); printf("codeline:%d ",code_num); 38 saveFile(file,s,code_num); 39 }
1 void searchfile() //寻找文件夹中的txt文件 2 { 3 struct _finddata_t filefind; 4 long handle; 5 int t=0; 6 if((handle=_findfirst("E:\\wordcount\\*.txt",&filefind))== -1L ) //文件txt存放位置 7 { 8 printf( "没找到txt文件\n"); 9 } 10 else 11 do{ 12 t++; 13 printf("找到文件:%s\n", filefind.name); 14 }while (_findnext(handle,&filefind)==0); 15 _findclose(handle); 16 printf("txt文件数量:%d\n",t); 17 } 18
1 将输出结果存储到指定文件: 2 void saveFile(char *fileName,char* feature,int num) 3 { 4 FILE *f=NULL; 5 f=fopen("F:\\gcc\\bin\\result.txt","a"); 6 if(f==NULL) 7 { 8 printf("failed when wrinting the count to file\n"); 9 } 10 //写入文件 11 fprintf(f,"%s,%s,%d\n",fileName,feature,num); 12 fclose(f); 13 }
测试结果:
写入到result文件里
4.单元测试
用来测试的a.txt和b.txt
测试结果:
5.总结
在运行代码和测试时花费了很多时间,有不少的bug出现,要么filenull要么返回的文件词数目不对。这次作业的基本功能全部实现,扩展功能实现一小部分,由于代码环节薄弱,花了很多时间去改错。测试阶段里,利用不同的测试文件才会发现其中的一些容易疏忽的小错误,可见测试的重要和必要性。在本例中,只举了三个测试案例来单元测试,剩下的就没有一一列举出来,可通过实践完善单元测试,保证其功能正常运行。