Counter V10 概要设计说明书.docx

1、Counter V10 概要设计说明书Counter V1.0 概要设计说明书拟制TProject项目组日期2003-06-08评审人日期yyyy-mm-dd修订记录日期修订版本CR号修改章节修改描述作者2003-06-081.00初稿完成TProject项目组目 录1 简介 61.1 目的 61.2 范围 61.2.1 软件名称 61.2.2 软件功能 61.2.3 软件应用 62 概要设计 62.1 总体设计描述 62.1.1 软件系统环境定义 62.2 第一层设计描述 62.2.1 分解描述 62.2.2 接口描述 102.3 第二层设计描述 152.3.1 界面模块 152.3.2 源

2、文件统计主控模块 162.3.3 参数检查模块 162.3.4 统计空行模块 172.3.5 统计代码行模块 172.3.6 统计注释行模块 182.3.7 统计总行数模块 182.3.8 统计结果输出模块 19表目录表1 界面模块选择被统计文件接口 11表2 界面模块选择统计空行接口 11表3 界面模块选择统计代码行接口 11表4 界面模块选择统计注释行接口 11表5 界面模块选择统计总行接口 12表6 界面模块退出Counter应用程序接口 12表7 源文件统计主控接口 12表8 参数检查模块接口 13表9 统计空行模块接口 13表10 统计代码行模块接口 13表11 统计注释行模块接口

3、14表12 统计总行数模块接口 14表13 统计结果输出模块接口 14表14 全局变量描述表 15图目录图1 软件模块结构图 7图2 Counter软件测试界面 7Counter V1.0 概要设计说明书关键词：Counter 代码统计工具、空行、代码行、注释行、总行数摘 要：本文是Counter V1.0的概要设计文档，是依据Counter V1.0软件需求说明书完成的。用来指导后续的详细设计和集成测试文档写作。缩略语清单： 缩略语英文全名中文解释1 简介1.1 目的Counter V1.0 概要设计说明数依据Counter V1.0软件需求规格说明书，针对每个具体的需求项目，给出具体的设计

4、方案。本文档用以指导后续的详细设计说明书和集成测试方案、计划和集成测试用例写作。1.2 范围1.2.1 软件名称Counter V1.01.2.2 软件功能参见Counter V1.0软件需求规格说明书2.2节。1.2.3 软件应用本软件用于TProject项目培训，作为软件测试能力培训的被测试对象，没有商用目的。2 概要设计 2.1 总体设计描述2.1.1 软件系统环境定义Counter V1.0是一个单线程的EXE文件，运行在WIN32平台上，功能单一，不与其他进程发生任何通信操作。2.2 第一层设计描述2.2.1 分解描述1. 模块/子系统分解下面图1是Counter V1.0的模块结构

5、图，该程序是基于GUI的应用程序，因此，都是由用户的输入触发软件的基本功能。因此，界面模块是应用程序的源头。参见图2，通过界面模块可以选择被统计的源文件，设置需要统计的类型，执行统计动作，退出应用程序等功能。通过用户界面，执行统计功能的时候，首先调用“源文件统计主控模块”，然后，由“源文件统计主控模块”按分别调用“参数检查模块”，“统计代码行模块”，“统计注释模块”，“统计空行模块”，“统计总行模块”，最后，通过调用“统计结果输出模块”把统计结果输出到界面的统计结果显示控件中。图1 软件模块结构图根据软件需求规格说明书，软件界面原型如下图2所示，包含“选择文件”按钮，四个统计方式选择CHECK

6、BOX，一个用于回显被选择文件的的编辑框，以及结果输出编辑框，“开始统计”按钮和“退出”按钮。图2 Counter软件测试界面1） 界面模块标识：HLD-COUNTER-001目的：该模块实现Counter 1.0的界面部分布局和界面控件的响应函数功能列表：A. 界面所有控件的布局B. 用户选择需要被统计的.c文件，并把用户选择的.c文件显示在编辑框中C. 用户选择需要的统计项目D. 用户执行统计操作E. 用户退出Counter对应的需求项目：A. SRS-COUNTER-001,002,003,0042） 参数检查模块标识：HLD-COUNTER-002目的：该模块实现对用户输入参数的合法性

7、检查 功能列表：A. 检查用户输入的.c文件名的合法性B. 检查用户选择的统计项的合法性对应的需求项目：A. SRS-COUNTER-001,002,003,0043） 统计空行模块标识：HLD-COUNTER-003目的：统计.c文件中的空行功能列表：A. 统计.c文件中的空行B. 调用结果输出模块，把结果输出到界面上对应的需求项目：A. SRS-COUNTER-0034） 统计代码行模块标识：HLD-COUNTER-004目的：统计.c文件中的代码行功能列表：A. 统计.c文件中的代码行B. 调用结果输出模块，把结果输出到界面上对应的需求项目：A. SRS-COUNTER-0015） 统计

8、注释行模块标识：HLD-COUNTER-005目的：统计.c文件中的注释行功能列表：A. 统计.c文件中的注释行B. 调用结果输出模块，把结果输出到界面上对应的需求项目：A. SRS-COUNTER-0026） 统计总行数模块标识：HLD-COUNTER-006目的：统计.c文件中的总行数功能列表：A. 统计.c文件中的总行数B. 调用结果输出模块，把结果输出到界面上对应的需求项目：A. SRS-COUNTER-0037） 统计结果输出模块标识：HLD-COUNTER-007目的：把统计结果输出到界面上功能列表：A. 把统计结果输出到界面上对应的需求项目：A. SRS-COUNTER-001,

9、002,003,0048） 代码统计主控模块标识：HLD-COUNTER-008目的：对参数检查模块、4个统计模块和统计输出模块统一调度功能列表：A. 调用参数检查模块，执行参数检查功能B. 调用统计空行模块，统计源文件中的空行C. 调用统计代码行模块，统计源文件中的代码行行D. 调用统计注释行模块，统计源文件中的注释行E. 调用统计总行数模块，统计源文件中的总行数F. 调用统计结果输出模块，输出源文件中的代码行、注释行、空行、总行。对应的需求项目：A. SRS-COUNTER-001,002,003,0042.2.2 接口描述1. 模块接口1） 界面模块接口软件界面模块提供如下6个接口，分别

10、为选择统计文件接口，选择统计空行接口，选择统计注释行接口，选择统计代码行接口，选择统计总行接口，退出Counter应用程序的接口。接口1选择被统计文件接口形式函数接口输入VOID 输出g_szStatFileName：全局变量，被统计文件的全路径。数据类型：字符串，有效的windows文件全路径名返回值VOID描述如图2所示，鼠标点击“选择文件”按钮，则调用该接口，弹出文件选择对话框，把选择的文件全路径赋值给全局变量g_szStatFileName。表1 界面模块选择被统计文件接口接口2选择统计项目统计空行的接口形式函数接口输入鼠标点“统计空行”复选框输出g_bStatBlankLineFla

11、g：全局变量，是否统计空行的标志位数据类型：布尔类型取值范围：STAT表示统计空行， NOT_STAT表示不统计空行返回值VOID描述如图2所示，鼠标点击“统计空行”的CHECKBOX控件，则调用该接口，如果选中统计空行控件，则 g_bStatBlankLineFlagSTAT，如果取消选中统计空行控件，则g_bStatBlankLineFlagNOT_STAT表2 界面模块选择统计空行接口接口3选择统计项目统计代码行的接口形式函数接口输入鼠标点“统计代码行”复选框输出g_bStatCodeLineFlag：全局变量，是否统计代码行的标志位数据类型：布尔类型取值范围：STAT表示统计代码行，

12、NOT_STAT表示不统计代码行返回值VOID描述如图2所示，鼠标点击“统计代码行”的CHECKBOX控件，则调用该接口，如果选中统计代码行控件，则 g_bStatCodeLineFlagSTAT，如果取消选中统计代码行控件，则g_bStatCodeLineFlagNOT_STAT表3 界面模块选择统计代码行接口接口4选择统计项目统计注释行的接口形式函数接口输入鼠标点“统计注释行”复选框输出g_bStatCommLineFlag：全局变量，是否统计注释行的标志位数据类型：布尔类型取值范围：STAT表示统计注释行， NOT_STAT表示不统计注释行返回值VOID描述如图2所示，鼠标点击“统计注释

13、行”的CHECKBOX控件，则调用该接口，如果选中统计注释行控件，则 g_bStatCommLineFlagSTAT，如果取消选中统计注释行控件，则g_bStatCommLineFlagNOT_STAT表4 界面模块选择统计注释行接口接口5选择统计项目统计总行的接口形式函数接口输入鼠标点“统计总行”复选框输出g_bStatTotalLineFlag：全局变量，是否统计总行的标志位数据类型：布尔类型取值范围：STAT表示统计总行， NOT_STAT表示不统计总行返回值VOID描述如图2所示，鼠标点击“统计总行”的CHECKBOX控件，则调用该接口，如果选中统计总行控件，则 g_bStatTota

14、lLineFlagSTAT，如果取消选中统计总行控件，则g_bStatTotalLineFlagNOT_STAT表5 界面模块选择统计总行接口接口6退出Counter应用程序的接口形式函数接口输入VOID输出无返回值VOID描述通过鼠标点击“退出”按钮结束应用程序Counter表6 界面模块退出Counter应用程序接口2） 源文件统计主控模块接口接口7代码统计主控接口形式函数接口输入VOID输出g_iBlankLineNum，统计得到的空行数g_iCodeLineNum，统计得到的代码行数g_iCommLineNum，统计得到的注释行数g_iTotalLineNum，统计得到的总行数返回值V

15、OID描述如图2所示，用户点击“开始统计”按钮的时候，主控模块调用参数检查模块，对输需要统计的文件全路径以及另外4个统计标志位做参数检查，并调用后面的4个统计模块和统计输出模块，最后把统计结果输出到UI界面上“统计结果”编辑框中表7 源文件统计主控接口3） 参数检查模块的接口接口1参数检查模块接口形式函数接口输入被统计的文件全路径名：szStatFileName数据类型：CString统计空行标志位：bStatBlankLineFlag数据类型：BOOL统计代码行标志位：bStatCodeLineFlag数据类型：BOOL统计注释行标志位：bStatCommLineFlag数据类型：BOOL统

16、计总行数标志位：bStatTotalLineFlag数据类型：BOOL 输出无返回值布尔类型：RET_OK-参数检查通过，RET_FALSE-参数检查不通过描述如果参数检查不通过，给用户相应的提示信息表8 参数检查模块接口4） 统计空行模块接口接口1统计空行模块接口形式函数接口输入参数1：用户选择的.c文件名。数据类型：字符串参数2：统计空行标志位。数据类型：布尔类型输出g_iBlankLineNum全局变量，统计.c文件得到的空行数，如果统计失败，该变量值为-1返回值VOID描述根据两个输入参数，统计.c文件中的空行数目，记录到全局变量g_iBlankLineNum中。表9 统计空行模块接口

17、5） 统计代码行模块接口接口1统计代码行模块接口形式函数接口输入参数1：用户选择的.c文件名。数据类型：字符串参数2：统计代码行标志位。数据类型：布尔类型输出g_iCodeLineNum全局变量，统计.c文件得到的代码行数，如果统计失败，该变量值为-1返回值VOID描述根据两个输入参数，统计.c文件中的代码行数目，记录到全局变量g_iCodeLineNum中。表10 统计代码行模块接口6） 统计注释行模块接口接口1统计注释行模块接口形式函数接口输入参数1：用户选择的.c文件名。数据类型：字符串参数2：统计注释行标志位。数据类型：布尔类型输出g_iCommLineNum（全局变量，统计.c文件得

18、到的注释行数，如果统计失败，该变量值为-1）返回值VOID描述根据两个输入参数，统计.c文件中的注释行数目，记录到全局变量g_iCommLineNum中。表11 统计注释行模块接口7） 统计总行数模块接口接口1统计注释行模块接口形式函数接口输入参数1：用户选择的.c文件名。数据类型：字符串参数2：统计总行数标志位。数据类型：布尔类型输出g_iTotalLineNum（全局变量，统计.c文件得到的总行数，如果统计失败，该变量值为-1）返回值VOID描述根据两个输入参数，统计.c文件中的总行数，记录到全局变量g_iTotalLineNum中。表12 统计总行数模块接口8） 统计结果输出模块接口接口

19、1统计结果输出模块接口形式函数接口输入参数1：统计类型数据类型：整型参数2：统计结果数据类型：整型 输出把统计结果输出到界面上的“统计结果”编辑框中返回值VOID描述该模块支持输出空行、代码行、注释行和总行结果到“统计结果”编辑框上。通过输入参数1和参数2分别确定需要输出结果的类型和统计值。表13 统计结果输出模块接口2. 全局变量、数据结构数据类型数据项定义数据项描述intg_iBlankLineNum记录统计得到的空行数目的全局变量intg_iCodeLineNum记录统计得到的代码行数目的全局变量intg_iCommLineNum记录统计得到的注释行数目的全局变量intg_iTotalL

20、ineNum记录统计得到的总行数的全局变量BOOLg_bStatBlankLineFlag统计空行标志位BOOLg_bStatCodeLineFlag统计代码行标志位BOOLg_bStatCommLineFlag统计注释行标志位BOOLg_bStatTotalLineFlag统计总行数标志位EnumSTAT=0,NOT_STAT枚举变量，STAT表示统计，NOT_STAT表示不统计，为上面的统计标志位赋值EnumSTAT_BLANK=0,STAT_CODE,STAT_COMM,STAT_TOTAL枚举变量，分别表示统计空行、代码行、注释行和总行数。当调用统计结果输出模块时，为第一个参数赋值CS

21、tringg_szStatFileName被统计的文件的文件全路径名EnumRET_OK0,RET_FAIL函数的返回值，RET_OK-返回成功，RET_FAIL-返回失败表14 全局变量描述表2.3 第二层设计描述2.3.1 界面模块1. 分解描述1) 选择被统计文件接口函数：VOID SelectStatFile（）功能：该函数完成选择被统计文件功能输入：用户点击“选择文件”按钮输出：g_szStatFileName选择的文件全路径名返回值：无2) 设置统计空行标志位接口函数：VOID SetStatBlankLineFlag()功能：该函数完成设置统计空行标志位的功能输入：用户点击“统计

22、空行”复选框 输出：g_bStatBlankLineFlag为统计空行标志位赋值返回值：无3) 设置统计代码行标志为接口函数：VOID SetStatCodeLineFlag()功能：该函数完成设置统计代码行标志位的功能输入：用户点击“统计代码行”复选框 输出：g_bStatCodeLineFlag为统计代码行标志位赋值返回值：无4) 设置统计注释行标志位接口函数：VOID SetStatCommLineFlag()功能：该函数完成设置统计注释行标志位的功能输入：用户点击“统计注释行”复选框 输出：g_bStatCommLineFlag为统计注释行标志位赋值返回值：无5) 设置统计总行数标志位

23、接口函数：VOID SetStatTotalLineFlag()功能：该函数完成设置统计总行标志位的功能输入：用户点击“统计总行”复选框 输出：g_bStatTotalLineFlag为统计空行标志位赋值返回值：无6) 退出Counter应用程序函数：VOID ExitCounter()功能：该函数完成退出Counter应用程序的功能输入：用户点击“退出”按钮 输出：退出Counter应用程序返回值：无2.3.2 源文件统计主控模块函数：VOID MainStatFun（）功能：该函数在用户通过界面单击“开始统计”按钮后，开始运行。该主控函数具有调度功能，分别调用参数检查模块、代码统计模块和统

24、计结果输出模块，完成一次统计执行过程输入：g_iBlankLineFlag,统计空行标志位;g_iCommLineFlag统计注释行标志位; g_iCodeLineFlag统计代码行标志位;g_iTotalLineFlag统计总行标志位;g_szStatFileName被统计文件的全路径名输出：g_iBlankLineNum，统计得到的空行数;g_iCodeLineNum，统计得到的代码行数;g_iCommLineNum，统计得到的注释行数;g_iTotalLineNum，统计得到的总行数;返回值：无2.3.3 参数检查模块1. 分解描述1) 参数检查主函数函数：BOOL CheckParam

25、eters（CString szStatFileName,BOOL bStatBlankLineFlag,BOOL bStatCodeLineFlag,BOOL bStatCommLineFlag,BOOL bStatTotalLineFlag）输入：参见表2输出：参见表2返回值：参见表2 2) 检查用户选择的被统计文件是否合法函数函数：BOOL CheckStatFile(CString szStatFileName)功能：该函数完成检查用户选择的被统计文件是否合法输入：szStatFileName用户选择的被统计文件输出：无返回值：TRUE-参数检查通过，FALSE-参数检查不通过3) 检

26、查用户选择的被统计项是否合法函数：BOOL CheckStatItem(BOOL bStatBlankLineFlag,BOOL bStatCodeLineFlag,BOOL bStatCommLineFlag,BOOL bStatTotalLineFlag)功能：该函数完成设置统计代码行标志位的功能输入：bStatBlankLineFlag统计空行标志位 bStatCodeLineFlag统计代码行标志位 bStatCommLineFlag统计注释行标志位 bStatTotalLineFlag统计总行数标志位输出：无返回值：TRUE-参数检查通过，FALSE-参数检查不通过2.3.4 统计空

27、行模块1. 分解描述1) 统计空行模块的主函数函数：VOID MainStatBlankLine（CString szStatFileName,BOOL bStatBlankLineFlag）功能：该函数对bStatBlankLineFlag做检查，如果需要统计空行，则调用StatBlankLine函数统计空行输入：szStatFileName用户选择的被统计文件 bStatBlankLineFlag统计空行标志位输出：g_iBlankLineNum全局变量，统计得到的空行数目返回值：无2) 统计空行模块的统计执行函数函数：VOID StatBlankLine（CString szStatFi

28、leName）功能：该函数完成对指定文件StatBlankLine的空行数目统计 输入：szStatFileName用户选择的被统计文件输出：g_iBlankLineNum全局变量，统计得到的空行数目返回值：无 2.3.5 统计代码行模块1. 分解描述1) 统计代码行模块的主函数函数：VOID MainStatCodeLine（CString szStatFileName,BOOL bStatCodeLineFlag）功能：该函数对bStatCodeLineFlag做检查，如果需要统计代码行，则调用StatCodeLine函数统计空行输入：szStatFileName用户选择的被统计文件 bS

29、tatCodeLineFlag统计代码行标志位输出：g_iCodeLineNum全局变量，统计得到的代码行数目返回值：无2) 统计代码行模块的统计执行函数函数：VOID StatCodeLine（CString szStatFileName）功能：该函数完成对指定文件StatCodeLine的空行数目统计 输入：szStatFileName用户选择的被统计文件输出：g_iCodeLineNum全局变量，统计得到的代码行数目返回值：无3)判断当前字符串是否是代码行函数：BOOL IsCodeLine（CString szStatFileLine,BOOL &bIsComment）功能：判断从文件中读取到的当前行是否为代码行输入：szSta