[发明专利]软件模型设计说明的生成方法

说明书

本发明公开了一种软件模型设计说明的生成方法，具体包括如下步骤步骤100：加载指定路径下的模型并获取模型的设计信息；步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。根据上述软件模型设计说明的生成方法，可以根据模型的设计信息生成符合指定标准的设计说明文件，便于设计信息的交流，并降低了开发人员的工作量。

技术领域

本发明涉及计算机软件领域，特别涉及一种软件模型设计说明的生成方法。

背景技术

在航空发动机全权限数字电子控制系统(FADEC)控制软件中越来越多地使用基于模型的开发方法(MBD)。在传统软件开发中，软件设计人员根据软件需求完成软件设计，在根据设计结果开展编码。而在MBD开发方法中，软件设计人员根据软件需求规格说明构建模型，之后由模型自动生成代码。因此，在基于模型的软件开发中，模型即为软件设计的结果。但是为了满足行业标准及与利益相关方交流的需要，仍需完成软件设计说明文档的编制，现有的基于模型的软件开发工具虽然支持设计说明文档的自动生成，但是其格式不能定制，无法满足一些行业的需求。

发明内容

发明目的：本发明的目的是提出一种软件模型设计说明的生成方法，可以生成符合标准的软件设计文档，节省开发人员时间。

技术方案：本发明所述软件模型设计说明的生成方法，具体包括如下步骤：

步骤100：加载指定路径下的模型并获取模型的设计信息；

步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；

步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。

进一步的，所述步骤100包括：

步骤110：加载指定路径下的模型的顶层模型；

步骤120：根据模型的工程文件中的引用关系，获取所有被顶层模型调用的子模型，并加载所有子模型；

步骤130：遍历顶层模型及所有子模型，获取顶层模型及子模型的设计信息。

进一步的，所述设计信息包括模型的全局信息及模型中所有模块的名称、组成及调用关系、执行时序、输入接口、输出接口、内部变量、模块注释及需求跟踪关系。

进一步的，所述全局信息包括常量、枚举类型、结构体类型定义。

进一步的，所述步骤300包括：

步骤310：根据设计信息中的模块的组成及调用关系信息生成设计说明文件中的“CSCI部件”章节内容；

步骤320：根据设计信息中的模块的执行时序生成设计说明文件中的“执行方案”章节内容；

步骤330：根据设计信息中的模块的名称、输入接口、输出接口、内部变量模块注释生成设计说明文件中的“CSCI详细设计”章节内容；

步骤340：根据设计信息中的模块的需求跟踪信息生成设计说明中的“软件需求跟踪矩阵”内容；

步骤350：更新设计文件目录信息，保存及关闭设计说明文件。

进一步的，所述步骤310中模块的组成及调用关系信息以树状图的形式记录于“CSCI部件”章节内容中。

进一步的，所述步骤320中的模块的执行时序以矩阵形式记录于“执行方案”章节内容。

有益效果：与现有技术相比，本发明具有如下优点：可以将指定模型的信息按指定的模板生成符合相应规范的设计说明文件，降低设计人员的工作量。

附图说明