文档生成方法、系统、设备和介质技术方案

本发明专利技术公开了一种文档生成方法、系统、设备和介质。提取目标开发软件中包含的模型类；如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档。本发明专利技术实施例提供的文档生成方法，实现了软件文档的自动生成，避免了软件开发项目中手工生成文档，缩短了开发时间，提高了开发效率。

Document generation methods, systems, devices and media

The invention discloses a document generation method, a system, a device and a medium. Extract the model class contained in the target development software; if the model class meets the requirement of document generation, then generate the corresponding development description document according to the programming code that constitutes the model class. The document generation method provided by the embodiment of the present invention realizes automatic generation of software documents, avoids manual generation of documents in software development projects, shortens development time and improves development efficiency.

【技术实现步骤摘要】
文档生成方法、系统、设备和介质
本专利技术实施例涉及计算机应用
，尤其涉及一种文档生成方法、系统、设备和介质。
技术介绍
软件开发说明文档是软件开发和后期运行维护过程中必不可少的重要资料，软件开发说明文档的存在可提高软件开发效率，保证软件开发质量。在web软件项目开发过程中,由于前后端分离开发，前台开发人员需要根据前端功能生成相应的开发说明文档，后端开发人员可以根据开发说明文档实现相应的后台逻辑，开发说明文档的存在保证了前后端功能实现一致。随着互联网技术的发展，前端开发技术和后端开发技术的差别越来越大，作为前端和后端的重要枢纽，开发说明文档变得越来越重要。目前，web软件项目开发过程中，通常由前后端开发人员共同定义文档形式，多采用手写开发说明文档的方式实现，文档形成过程繁琐且效率低下，严重影响了软件项目开发的效率。
技术实现思路
本专利技术提供一种文档生成方法、系统、设备和介质，以实现软件文档的自动生成。第一方面，本专利技术实施例提供了一种文档生成方法，该方法包括:提取目标开发软件中包含的模型类；如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档。第二方面，本专利技术实施例还提供了一种文档生成系统，该系统包括：提取模块，用于提取目标开发软件中包含的模型类；文档生成模块，用于如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档。第三方面，本专利技术实施例还提供了一种设备，所述设备包括：一个或多个处理器；存储器，用于存储一个或多个程序，当所述一个或多个程序被所述一个或者多个处理器执行，使得所述一个或多个处理器实现如本专利技术实施例中任一所述的文档生成方法。第四方面，本专利技术实施例还提供了一种计算机可读存储介质，该程序被处理器执行时实现如本专利技术实施例中任一所述的文档生成方法。本专利技术实施例通过获取目标开发软件中的所有模型类，然后将满足文档生成要求的模型类提取出来，然后根据该模型类的编程代码生成对应的开发说明文档，解决了传统文档需要程序员手工填写，造成文档生成效率低的问题，缩短了文档生成时间。附图说明图1是本专利技术实施例一提供的一种文档生成方法的步骤流程图；图2是本专利技术实施例二提供的一种文档生成方法的步骤流程图；图3是本专利技术实施例三提供的一种文档生成系统的结构示意图；图4是本专利技术实施例四提供的一种设备的结构示意图。具体实施方式下面结合附图和实施例对本专利技术作进一步的详细说明。可以理解的是，此处所描述的具体实施例仅仅用于解释本专利技术，而非对本专利技术的限定。另外还需要说明的是，为了便于描述，附图中仅示出了与本专利技术相关的部分而非全部结构。实施例一图1是本专利技术实施例一提供的一种文档生成方法的步骤流程图，本实施例可适用于软件文档自动生成的情况，该方法可以由文档生成系统来执行，所述文档生成系统可以由软件/硬件实现，具体包括如下步骤：步骤101、提取目标开发软件中包含的模型类。其中，目标开发软件可以是新开发的或者原有但缺少软件说明文档的软件，模型类可以是目标开发软件中处于模型层的数据类，具体可用于设置或者获取数据的属性，还可以用于控制数据进行处理。具体的，可以获取目标开发软件中所有类的代码文件，判断其中是否存在属于模型层中的数据类或者设置或获取数据的类，如果存在该类，则获取该类的代码文件。示例性的，可以将模型类读入Spring框架中的上下文容器中，统一使用Bean获取模型类的相关信息，此外还可以采用遍历的方式逐个获取目标开发软件的类文件，判断该类是否属于模型层，如果属于模型层，则获取该类的代码文件。步骤102、如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档。其中，文档生成要求可设定为模型类的编程代码符合的编写规范，例如，若模型类的编程代码符合Spring注解规则和restfut开发风格并且编程代码内包括接口关键字Interface或者控制类函数关键字Controller，则说明模型类符合文档生成要求，可以理解的是，文档生成要求并不仅限于上述情况，还可以包括模型类的编程代码仅符合Spring注解规则或模型类的编程代码仅满足restfut开发风格等，开发说明文档的存储形式可以是静态存储的文件和动态的网页。具体的，如果所获取模型类符合Spring注解规则和restfut开发风格，并且编程代码包括接口关键字Interface或者控制类函数关键字Controller，那么该模型类符合文档生成要求，则可以根据从该模型类的编程代码中提取关键信息生成模型类对应的文档，示例性的，可以使用第三方开发包swagger和springfox实现开发说明文档的生成。可以理解的是，本实施例可以一个模型类对应一个开发说明文档，也可以一个目标开发软件对应一个开发说明文档。本实施例的技术方案，通过获取目标开发软件的模型类，提取符合文档生成要求的模型类，根据该模型类的编程代码自动生成开发说明文档；解决了传统文档由于需要程序员手动撰写，导致开发说明文档生成效率低的问题，减少了开发说明文档生成时间。在上述技术方案的基础上，优选的，提取目标开发软件中包含的模型类包括：提取所述目标开发软件中的配置参数，并获取与所述配置参数关联的模型类。其中，配置参数可以是目标开发软件模型类的配置规则和相关参数，可以包括模型类实例化过程使用的容器的命名空间和扫描模型类使用的基类包等。具体的，可以读取配置文件中的模型类实例化使用的命名空间和扫描模型类使用的基类包，利用读取的命名空间生成承载模型类的容器，在生成的容器内使用获取的基类包扫描模型类，并获得扫描到的模型类。示例性的，在Spring框架下，创建上下文容器，根据配置文件加载模型类Bean到上下文容器中，从而获得目标开发软件中的模型类。上述技术方案，根据目标开发软件中的配置参数获取与配置参数关联的模型类，使得模型类可被统一管理，简化模型类自动生成开发说明文档的复杂度，有利于提高开发说明文档生成效率。实施例二图2是本专利技术实施例二提供的一种文档生成方法的步骤流程图。本实施例是在上述实施例的基础上提出的一种可选方案。参见图2，本专利技术实施例提供的文档生成方法包括：步骤201、提取目标开发软件中的配置参数，并获取与所述配置参数关联的模型类。步骤202、确定构成所述模型类的第一编程代码中是否包含接口信息和注解信息。其中，第一编程代码可以是模型层的数据类的构成代码，接口信息可以是含有接口关键字Interface的信息，注解信息可以是含有注解关键字@的信息。具体的，可以获取模型层的数据类的构成代码，判断构成代码中是否存在接口关键字Interface和注解关键字@，如果构成代码中含有接口关键字Interface和注解关键字@，那么可以认为确定构成模型类的第一编程代码中包含有接口信息和注解信息，示例性的，判断构成代码中是否存在接口关键字和注解关键字的方法可以使用正则表达式在模型类的构成代码中匹配Interface和@，获取Interface和@后面出现的相关信息。如果步骤202中确定模型类的第一编程代码中包含接口信息和注解信息，则继续执行步骤2021至2023，以生成模型类的开发说明文档。步骤2021、从预先设定的文档生成模板集合中查找与所述接口信息匹配的第一目标生成模板本文档来自技高网...

【技术保护点】
1.一种文档生成方法，其特征在于，包括：提取目标开发软件中包含的模型类；如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档。

【技术特征摘要】
1.一种文档生成方法，其特征在于，包括：提取目标开发软件中包含的模型类；如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档。2.根据权利要求1所述的方法，其特征在于，所述提取目标开发软件中包含的模型类，包括：提取所述目标开发软件中的配置参数，并获取与所述配置参数关联的模型类。3.根据权利要求1所述的方法，其特征在于，如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档，包括：如果构成所述模型类的第一编程代码中包含接口信息和注解信息，则基于第一生成规则生成所述模型类的开发说明文档。4.根据权利要求1所述的方法，其特征在于，所述基于第一生成规则生成所述模型类的开发说明文档，包括：从预先设定的文档生成模板集合中查找与所述接口信息匹配的第一目标生成模板；从所述第一编程代码中注解信息提取满足第一填充要求的第一填充信息；基于设定填充规则将所述第一填充信息填充至所述第一目标生成模板中，获得对应所述接口信息的开发说明文档。5.根据权利要求1所述的方法，其特征在于，如果所述模型类满足文档生成要求，则根据构成所述模型类的编程代码生成相应的开发说明文档，包括：如果所述模型类属于控制类函数，则基于第二生成规则生成所述模型类的开发说明...

【专利技术属性】
技术研发人员：万月亮，丁洁冰，火一莽，
申请(专利权)人：北京锐安科技有限公司，
类型：发明
国别省市：北京,11