需求变更的逆向追踪系统的制作方法

文档序号:12596561阅读:509来源:国知局

本发明涉及一种追踪系统,具体地,涉及一种需求变更的逆向追踪系统。



背景技术:

在软件的开发过程中,由于需求发生变更以及需求理解上的偏差,会导致原有的需求分析要记录其变更信息。由此会导致开发时,各类文档如需求分析文档、详细设计文档、概要设计文档等大量文档需要进行同步更新处理,不仅工作量大,而且复杂繁琐,并需要增加人员及开发工时以应对这些变动。文档往往没有及时进行更新,新的需求或变动又产生了,从而加大了人工进行需求变更追踪处理的难度。



技术实现要素:

针对现有技术中的缺陷,本发明的目的是提供一种需求变更的逆向追踪系统,其不仅可以进行需求的逆向追踪,而且文档的修改也无需增加大量的人工处理。

根据本发明的一个方面,提供一种需求变更的逆向追踪系统,其特征在于,包括如下模块:

注释设置模块,其用于配置源代码的注释格式配置,用于从源代码中提取注释信息,为文档的生成提供数据支持;

源代码分析模块,用于分析源代码,提取所有的变量、结构体、函数、函数执行流程信息;通过提取所有相关信息环节,生成特定格式的数据,便于分析处理,生成相应的功能部件,真实的反应当前项目的整体情况,为整个项目的逆向追踪提供最直接的数据来源;

报告模块,用于将源代码分析的结果生成文档,便于需求变更的逆向追踪;并可根据报告模块来生成对应的标准文档;对于已有的报告模板,可进行导入导出文件,并对报告模板进行编辑操作;通过将数据导入不同的报告模板,来生成各类型的文档,形成对需求以及源代码的逆向追踪,为整个项目的整体逻辑和开发情况提供最佳的信息展示;

显示管理模块,用于显示源代码各部件的函数信息、参数信息、以及对分析后的源代码文件进行标准化更新;并提供相关的可操作管理界面,进行项目信息的调整、编辑、设置;并提供函数的伪代码、流程图、调用图的查看;通过将整理后的数据信息,归纳为不同形式的信息单元,为更好的掌握项目的整体情况、各模块的基本信息单元以及拆分到函数组件、类型组件的基本数据块,提供展示平台。

优选地,所述注释设置模块包括如下模块:

源代码注释格式设置模块,其用于根据源代码而设定的注释规范;

源代码注释模板模块,其用于显示用户设置注释后,根据其输入,在代码模板上,自动根据其配置信息生成相应的注释框架,以便于用户理解与使用;提供按该注释设置后,生成注释的格式;

注释解析模块,根据用户的注释配置,对用户的源代码进行注释分析,提取所有相关的元素,加以关键字的分类,最终将所有要素信息汇总;为用户实现源代码的逆向分析和文档的生成,提供最直接的数据来源支持;

自动生成注释框架模块,根据提取的所有信息以及用户配置的注释模板,生成要素齐全的注释,在一定程度上便于开发人员规范注释的书写以及理解程序,同时也保证所有注释风格的一致性以及信息的有效性。

优选地,所述源代码分析模块包括如下模块:

项目管理模块,其用于待分析项目的新建,添加待分析文件,设置源代码分析的文件编码、分析模式、注释位置、外部文件、宏定义、流程图参数定义、结构图参数定义,对项目中组件信息进行修改删除;

静态分析模块,使用本系统对源代码进行分析,并提取相关的信息单元,为文件组件、类型组件、函数组件、度量信息模块的创建提供数据来源;

文件组件模块,其用于组织文件的基本数据单元,包含类型组件、函数组件;

类型组件模块,其用于记录源代码中的数据类型信息,包括结构体、各种类型参数;

函数组件模块,其用于记录函数的基本信息,包含函数名称、注释、参数、返回值,函数的调用关系和函数的处理流程,为生成流程图和调用图提供数据来源;函数组件模块中还包含函数在源代码文件中的位置信息,便于在显示模块中进行查看;

度量信息模块,其用于提取函数的流程、调用关系,为项目分析提供相关的度量信息;为生成文档时,提供调用图和流程图的数据来源。

优选地,所述报告模块包括如下模块:

报告模板模块,用于自定义报告模板格式,以及生成的内容章节,也可以在现有的报告模板基础上,进行报告生成内容模板的编辑处理;

报告生成模块,用于根据报告模板的格式,提取所有源代码中已经分析出来的数据单元,将其汇总整理后,自动生成需要的详细设计文档、概要设计文档、需求分析文档;

报告导入导出模块,用于报告模板文件的导入和导出,通过对模板的管理,来完成文档的内容与格式的生成。

优选地,所述显示管理模块包括如下模块:

组件逻辑视图模块,其用于显示项目的函数信息、部件信息、变量、数据类型,并提供查看和管理窗口;对函数包含的参数、返回值信息通过HTML查看;函数组件的伪代码、流程图、调用图均通过;同时,对于每一次生成的报告文件,均可进行查看并管理,便于项目需求变更的逆向追踪和查看;

文件浏览模块,其用于展示项目的源代码文件,并显示对应文件包含的函数信息,文件度量信息;并可根据配置的注释信息,对源代码文件插入标准的注释框架;

管理模块,其用于对项目整体的管理,包含项目模板管理、注释管理、全局设置管理、信息单元的创建和修改、删除。

优选地,所述注释格式配置包含函数头注释、全局变量和局部变量注释。

与现有技术相比,本发明具有如下的有益效果:(1)实现了对项目源代码的跟踪与回溯,并快速形成规范的文档。(2)实现了模板方式定义报告文档,并快速生成。(3)实现了无需求文档进行开发时,快速跟踪其开发模块功能等,便于用户对项目的分析和需求追踪,以及相关文档的及时性、有效性和可靠性,以及不同版本的需求跟踪。(4)实现了快速理解项目的执行流程,处理模块、各部件之间的耦合关系以及项目的信息度量等。(5)实现了需求的无差错自动化生成,快速有效提高软件的开发效率。(6)多种方式展示提取的项目源代码信息,有效直观的反应了项目的进展以及部件功能的开发和完成程度,便于完善模块的功能和软件的开发进程。(7)通过提取源代码信息,自动生成注释框架,减小了写注释的工作量,同时,保持所有注释格式的高度一致性和信息的有效性,便于养成开发人员规范开发项目,书写注释的习惯。

附图说明

通过阅读参照以下附图对非限制性实施例所作的详细描述,本发明的其它特征、目的和优点将会变得更明显:

图1为本发明需求变更的逆向追踪系统的原理框图。

具体实施方式

下面结合具体实施例对本发明进行详细说明。以下实施例将有助于本领域的技术人员进一步理解本发明,但不以任何形式限制本发明。应当指出的是,对本领域的普通技术人员来说,在不脱离本发明构思的前提下,还可以做出若干变形和改进。这些都属于本发明的保护范围。

如图1所示,本发明需求变更的逆向追踪系统包括如下模块:

注释设置模块,其用于配置源代码的注释格式配置,用于从源代码中提取注释信息,为文档的生成提供数据支持;注释格式配置包含函数头注释、全局变量和局部变量注释等。在存在特殊源代码格式时,应根据其源代码中信息进行配置,定义其注释解析方法,便于信息的归纳与提取。设置好的注释格式为自动生成注释框架,提供其规范的格式,有利于项目的注释规范处理。

源代码分析模块,用于分析源代码,提取所有的变量、结构体、函数、函数执行流程等信息;通过提取所有相关信息环节,生成特定格式的数据,便于分析处理,生成相应的功能部件,真实的反应当前项目的整体情况,为整个项目的逆向追踪提供最直接的数据来源。

报告模块,用于将源代码分析的结果生成文档,便于需求变更的逆向追踪;并可根据报告模块来生成对应的标准文档;对于已有的报告模板,可进行导入导出文件,并对报告模板进行编辑操作。通过将数据导入不同的报告模板,来生成各类型的文档,形成对需求以及源代码的逆向追踪,为整个项目的整体逻辑和开发情况,提供最佳的信息展示。

显示管理模块,用于显示源代码各部件的函数信息、参数信息、以及对分析后的源代码文件进行标准化更新;并提供相关的可操作管理界面,进行项目信息的调整、编辑、设置等操作。并提供函数的伪代码、流程图、调用图等的查看。通过将整理后的数据信息,归纳为不同形式的信息单元,为更好的掌握项目的整体情况、各模块的基本信息单元以及拆分到函数组件、类型组件的基本数据块,提供展示平台。

其中,注释设置模块包括如下模块:

源代码注释格式设置模块,其用于根据源代码而设定的注释规范。为了适用本系统,源代码的注释必须满足一定的格式,以便于函数等的解析、提取相关信息,并使用提取的信息生成相关的问题,实现需求变更的逆向追踪等。因此项目源代码必须预先按照一定的注释规范进行编程,以便于提取信息。源代码的良好注释风格,有利于项目信息的提取和分析,同时良好的注释风格也有利于理解和开发模块等的功能,以及掌握函数的基本信息、输入输出参数、返回值等。自动生成注释框架时,需要使用配置好的源代码注释格式,来生成统一的源代码注释,保证整个项目的注释的完整和统一。

源代码注释模板模块,其用于显示用户设置注释后,根据其输入,在代码模板上,自动根据其配置信息生成相应的注释框架,以便于用户理解与使用;提供按该注释设置后,生成注释的格式。

注释解析模块,根据用户的注释配置,对用户的源代码进行注释分析,提取所有相关的元素,加以关键字的分类,最终将所有要素信息汇总。为用户实现源代码的逆向分析和文档的生成,提供最直接的数据来源支持。

自动生成注释框架模块,根据提取的所有信息以及用户配置的注释模板,生成要素齐全的注释,在一定程度上便于开发人员规范注释的书写以及理解程序,同时也保证所有注释风格的一致性以及信息的有效性。

其中,源代码分析模块包括如下模块:

项目管理模块,其用于待分析项目的新建,添加待分析文件,设置源代码分析的文件编码、分析模式、注释位置、外部文件、宏定义、流程图参数定义、结构图参数定义,对项目中组件信息进行修改删除等。

静态分析模块,使用本系统对源代码进行分析,并提取相关的信息单元,为文件组件、类型组件、函数组件、度量信息等模块的创建提供数据来源。

文件组件模块,其用于组织文件的基本数据单元,包含类型组件、函数组件等。

类型组件模块,其用于记录源代码中的数据类型信息,包括结构体、各种类型参数。

函数组件模块,其用于记录函数的基本信息,包含函数名称、注释、参数、返回值,函数的调用关系和函数的处理流程等,为生成流程图和调用图提供数据来源。函数组件中还包含函数在源代码文件中的位置信息,便于在显示模块中进行查看。

度量信息模块,其用于提取函数的流程、调用关系等,为项目分析提供相关的度量信息。为生成文档时,提供调用图和流程图的数据来源。度量信息模块还包含函数的注释行、代码行、总行数、空白行等统计数据。

其中,报告模块包括如下模块:

报告模板模块,用于自定义报告模板格式,以及生成的内容章节,也可以在现有的报告模板基础上,进行报告生成内容等模板的编辑处理。

报告生成模块,用于根据报告模板的格式,提取所有源代码中已经分析出来的数据单元,将其汇总整理后,自动生成需要的详细设计文档、概要设计文档、需求分析文档等。

报告导入导出模块,用于报告模板文件的导入和导出,通过对模板的管理,来完成文档的内容与格式的生成。

其中,显示管理模块包括如下模块:

组件逻辑视图模块,其用于显示项目的函数信息、部件信息、变量、数据类型等,并提供查看和管理窗口。对函数包含的参数、返回值等信息通过HTML查看。函数组件的伪代码、流程图、调用图等均可以通过。同时,对于每一次生成的报告文件,均可进行查看并管理,便于项目需求变更的逆向追踪和查看。

文件浏览模块,其用于展示项目的源代码文件,并显示对应文件包含的函数信息,文件度量信息等。并可根据配置的注释信息,对源代码文件插入标准的注释框架。

管理模块,其用于对项目整体的管理,包含项目模板管理、注释管理、全局设置管理、信息单元的创建和修改、删除等。

本发明不仅可以进行需求的逆向追踪,而且文档的修改也无需增加大量的人工处理。首先,根据需求变更实现编码的变更。其次,分析源代码的更改,自动生成详细设计文档、概要设计文档、需求分析文档,详尽记录其变更情况。需求变更的逆向追踪系统,由于是基于项目源代码进行分析,因此更能快速可靠地反应当前项目的整体情况以及相关需求的处理逻辑,尽可能避免人工操作带来的错误,极大程度提高了文档生成的质量和需求的完整,确保项目的需求追踪的及时性和有效性,为项目开发提供有效的帮助。由于是基于整个项目源代码的逆向分析,因此开发人员也更容易了解到项目的基本执行流程,函数的调用等情况,根据生成的文档或显示视图,从而了解和掌握当前需求的完成情况,并根据模块信息进行分析和总结问题。

以上对本发明的具体实施例进行了描述。需要理解的是,本发明并不局限于上述特定实施方式,本领域技术人员可以在权利要求的范围内做出各种变形或修改,这并不影响本发明的实质内容。

当前第1页1 2 3 
网友询问留言 已有0条留言
  • 还没有人留言评论。精彩留言会获得点赞!
1