WordCount

---

前排指路
软工项目开发-WordCount(2)
软工项目开发-WordCount(3)
github地址

---

1. 项目要求

WC.exe是一个常见的工具，它能统计文本文件的字符数、单词数和行数。这个项目要求写一个命令行程序，模仿已有wc.exe的功能，并加以扩充，给出某程序设计语言源文件的字符数、单词数和行数。
实现一个统计程序，它能正确统计程序文件中的字符数、单词数、行数，以及还具备其他扩展功能，并能够快速地处理多个文件。

• 具体功能要求：
  程序处理用户需求的模式为：
  wc.exe [parameter] [file_name]

  • 基本功能列表：

     wc.exe -c file.c //返回文件 file.c 的字符数
     wc.exe -w file.c //返回文件 file.c 的词的数目
     wc.exe -l file.c //返回文件 file.c 的行数
    

  • 扩展功能：

     -s 递归处理目录下符合条件的文件
     -a 返回更复杂的数据（代码行/空行/注释行）
    

    空行：本行全部是空格或格式控制字符，如果包括代 码，则只有不超过一个可显示的字符，例如“{”。
    代码行：本行包括多于一个字符的代码。
    注释行：本行不是代码行，并且本行包括注释。一个有趣的例子是有些程序员会在单字符后面加注释：
    } //注释
    在这种情况下，这一行属于注释行。

  • 高级功能：
    -x 参数。这个参数单独使用。如果命令行有这个参数，则程序会显示图形界面，用户可以通过界面选取单个文件，程序就会显示文件的字符数、行数等全部统计信息。
    需求举例：
    wc.exe -s -a *.c
    返回当前目录及子目录中所有*.c文件的代码行数、空行数、注释行数。

---

2. PSP

PSP2.1	Personal Software Process Stages	预估耗时（分钟）	实际耗时（分钟）
Planning	计划	60
Estimate	估计这个任务需要多少时间	30
Development	开发	1440
Analysis	需求分析（包括学习新技术）	240
Design Spec	生成设计文档	50
Design Review	设计复审（和同事审核设计文档）	60
Coding Standard	代码规范（为目前的开发制定合适的规范）	40
Dedign	具体设计	60
Coding	具体编码	600
Code Review	代码复审	70
Test	测试（自我测试，修改代码，修改提交）	200
Reporting	报告	120
Test Report	测试报告	70
Size Measurement	计算工作量	20
Postmortem & Process Improvement Plan	事后总结，并提出过程改进计划	40
	合计	3100

3. 问题定义

相比其他项目，该问题第一眼看上去较为简单，且要求清晰明确，即对于用户输入的某个文件或目录，根据用户要求（即用户输入参数）对其内容进行检索，并将检索内容呈现给用户，同时，可以构建一个UI界面供用户选择文件。

4. 可行性分析

该项目为历届学生所做，网络上有往届多位学长学姐的博客和代码作为参考思路。C#作为一门成熟的面向对象语言，其类和方法较为完善，有助于本项目的完成。对于递归目录的实现，本学期OS课设曾有一个使用C++完成文件复制的实验，笔者认为-s的实现原理与其类似。除此之外，暑假我曾接触过winform程序的开发，对使用C#进行UI界面的开发较为熟悉，虽然本项目选择（更为先进的）WPF作为开发框架，但所谓换汤不换药，这两种架构对于此项目来说大同小异。
本项目的开发环境为win10 + Visual Studio 2019 + C#。

5. 需求分析

分析完结对项目要求文档后，笔者认为，该项目有以下需求：

功能需求

1. 对文件的字符数进行统计
2. 对文件的单词数进行统计
3. 对文件的行数进行统计
4. 对文件的空行、代码行、注释行进行统计
5. 对文件夹中的文件进行上述统计
6. 对在UI界面中选中的文件进行上述统计

性能需求
希望统计能尽可能快。

6. 程序设计

6.1 用例图

6.2 思路描述

1. 若输入为文件，可读取其全部内容，将其保存在字符串中，根据命令行参数（-w/-c/-l等）对字符串进行遍历统计。
2. 若输入为目录，可对当前目录及所有子目录进行遍历，找到所有符合条件的文件放入文件列表中，再对单个文件进行1操作。
3. 若输入为-x，则调用图形界面函数，在UI中选择某文件后，同样对该文件执行1操作。

6.3 程序流程图

6.4 功能实现思路

将项目分为三部分：

• 基础功能和扩展功能（-a）
• 递归处理（实现-s的基础）
• 图形界面

项目划分为三个模块进行编写，完成如上三部分内容。全项目如下图所示。

• Utils类负责完成基础功能和扩展功能，它对输入指令进行解析，并执行相应操作。定义CountChars/CountWords/CountLines/CountOthers等函数，完成对应的-c/-w/-l/-a功能。
• FileSet类负责完成对目录的递归操作，通过TraverseDir函数实现逐层将文件加入列表供之后遍历。
• MainWindow完成图形界面的绘制。本作业使用WPF作为框架实现UI。
• ConsoleCtrl实现打开图形界面后终端最小化。
• App.xaml.cs中是Main函数。