[发明专利]基于代码的文档自动生成方法、装置、电子设备及介质

说明书

本发明涉及计算机领域，具体涉及一种基于代码的文档自动生成方法、装置、电子设备及介质。所述方法包括：检查所述代码文件是否有异常；在确认所述代码文件无异常时从所述代码文件中获取代码；从所述代码中获取用于处理流程的类的语句，确定所述用于处理流程的类的语句的顺序流程；根据用于处理流程的类的语句的顺序流程生成类的流程流转图；及根据所述类的流程流转图生成所述代码文件对应的文档。本发明能够根据代码生成流程图，使得生成的文档内容更加完善。

技术领域

本发明涉及计算机领域，具体涉及一种基于代码的文档自动生成方法、装置、电子设备及介质。

背景技术

目前根据代码生成文档主要有两种方式，一种是根据代码注释生成api文档，另一种是根据类与类之间的关系生成类图。然而，这两种代码生成方式比较独立，缺乏对代码逻辑的输出以及相关负责人员的说明，不适用于程序员之间的技术文档输出。

发明内容

鉴于以上内容，有必要提出一种基于代码的文档自动生成方法、装置、电子设备和计算机可读存储介质，以根据代码生成流程图，能够使得生成的文档内容更加完善。

本申请的第一方面提供一种基于代码的文档自动生成方法，所述方法包括：

检查所述代码文件是否有异常；

在确认所述代码文件无异常时从所述代码文件中获取代码；

从所述代码中获取用于处理流程的类的语句，确定所述用于处理流程的类的语句的顺序流程；

根据用于处理流程的类的语句的顺序流程生成类的流程流转图；及

根据所述类的流程流转图生成所述代码文件对应的文档。

优选地，所述方法还包括：

获取所述代码文件中的类；

识别所述代码文件中所述类之间的继承及引用关系；

根据所述类的继承及引用关系生成类图；及

根据所述类图生成所述代码文件对应的文档。

优选地，所述方法还包括：

获取所述代码文件中的注释信息；及

根据获取的注释信息生成所述代码文件对应的文档。

优选地，所述方法还包括：

识别所述代码文件中代码的程序语言调用关系；

生成相应的函数调用关系图表；及

根据所述函数调用关系图表生成所述代码文件对应的文档。

优选地，所述方法还包括：

根据所述代码文件生成修改记录；及

根据所述修改记录生成所述代码文件对应的文档。

优选地，所述根据所述代码文件生成修改记录及根据所述修改记录生成所述代码文件对应的文档包括：

根据代码管理工具生成txt文档的代码修改记录,使用Git命令获取所述代码文件中每一个代码中的每一个分支上对应的用户在过去设定时间内所进行的修改记录，并将所有修改记录存储在一个txt文档中；

使用python脚本，提取所述txt文档中的数据输入到所述文档中。

优选地，所述检查代码文件是否有异常包括：

将所述代码文件分为至少一个类别块；