一种文档生成方法、装置、智能设备及存储介质制造方法及图纸

本申请实施例公开了一种文档生成方法、装置、智能设备及存储介质，本申请实施例可以获取编程文件；在编译所述编程文件时，解析所述编程文件，得到所述编程文件中的描述符；读取所述编程文件的注释内容；将所述注释内容与所述描述符进行匹配；根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档。解决了手动编写编程文件的说明文档效率低的问题，提高了编程文件的说明文档生成效率。提高了编程文件的说明文档生成效率。提高了编程文件的说明文档生成效率。

【技术实现步骤摘要】
一种文档生成方法、装置、智能设备及存储介质


[0001]本申请涉及计算机
，具体涉及一种文档生成方法、装置、智能设备及存储介质。

技术介绍

[0002]在目前的Vue3(即Vue3.js，一种JavaScript框架)界面项目工程化开发中，普遍采用SFC(Sequeential Function Chart，图形编程文件)方式编写组件。为了方便项目的维护、运营与使用，针对重要的功能组件、UI组件库都必须编写相关说明文档进行记录说明。
[0003]说明文档编写工作一般由组件开发人员手动编写完成，对于小型项目或组件数量偏小的项目，手动编写的方式任务量还可以接受，但是对于大型项目，如：UI组件库，手动编写说明文档的工作量往往与组件开发任务量一致，甚至超出，因此手动编写编程文件的说明文档效率低，会导致项目开发效率低。

技术实现思路

[0004]本申请实施例提供一种文档生成方法、装置、智能设备及存储介质，可以提高编程文件的说明文档生成效率。
[0005]为解决上述技术问题，本申请实施例提供以下技术方案：
[0006]本申请实施例提供了一种文档生成方法，包括：
[0007]获取编程文件；
[0008]在编译所述编程文件时，解析所述编程文件，得到所述编程文件中的描述符；
[0009]读取所述编程文件的注释内容；
[0010]将所述注释内容与所述描述符进行匹配；
[0011]根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档。
[0012]在一实施方式中，所述将所述注释内容与所述描述符进行匹配，包括：
[0013]获取所述注释内容中的各个代码注释对应的目标描述符；
[0014]若所述描述符与所述目标描述符相同，则判定所述描述符与所述注释内容中的代码注释匹配。
[0015]在一实施方式中，所述根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档，包括：
[0016]若所述描述符与所述注释内容中的代码注释匹配，则将所述描述符以及与所述描述符匹配的所述代码注释关联写入预设标记文档中，以生成所述编程文件对应的说明文档。
[0017]在一实施方式中，所述解析所述编程文件，得到所述编程文件的描述符包括：
[0018]获取预设解析工具；
[0019]根据所述预设解析工具解析所述编程文件，得到所述编程文件的描述符。
[0020]在一实施方式中，所述读取所述编程文件的注释内容，包括：
[0021]获取预设正则表达式；
[0022]根据所述预设正则表达式检索编程文件的内容，以读取编程文件中代码的注释内容。
[0023]根据本申请的一个方面，还提供了一种文档生成装置，包括：
[0024]获取模块，用于获取编程文件；
[0025]解析模块，用于在编译所述编程文件时，解析所述编程文件，得到所述编程文件中的描述符；
[0026]读取模块，用于读取所述编程文件的注释内容；
[0027]匹配模块，用于将所述注释内容与所述描述符进行匹配；
[0028]生成模块，用于根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档。
[0029]在一实施方式中，所述文档生成装置，还包括：
[0030]获取模块，用于获取所述注释内容中的各个代码注释对应的目标描述符；
[0031]判定模块，用于若所述描述符与所述目标描述符相同，则判定所述描述符与所述注释内容中的代码注释匹配。
[0032]在一实施方式中，所述文档生成装置，还包括：
[0033]生成模块，用于若所述描述符与所述注释内容中的代码注释匹配，则将所述描述符以及与所述描述符匹配的所述代码注释关联写入预设标记文档中，以生成所述编程文件对应的说明文档。
[0034]根据本申请的一个方面，还提供了一种智能设备，包括处理器和存储器，所述存储器中存储有计算机程序，所述处理器调用所述存储器中的计算机程序时执行本申请实施例提供的任一种文档生成方法。
[0035]根据本申请的一个方面，还提供了一种存储介质，所述存储介质用于存储计算机程序，所述计算机程序被处理器加载，以执行本申请实施例提供的任一种文档生成方法。
[0036]本申请实施例可以获取编程文件；在编译所述编程文件时，解析所述编程文件，得到所述编程文件中的描述符；读取所述编程文件的注释内容；将所述注释内容与所述描述符进行匹配；根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档。这样在开发Vue3项目对编程文件进行编译时智能设备可以将编程文件的描述符与注释内容进行匹配从而自动生成编程文件的说明文档，提高了编程文件的说明文档生成效率。
附图说明
[0037]为了更清楚地说明本申请实施例中的技术方案，下面将对实施例描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的一些实施例，对于本领域技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。
[0038]图1是本申请实施例提供的文档生成方法的流程示意图；
[0039]图2是本申请实施例提供的文档生成方法的一实施例的示意图。
[0040]图3是本申请实施例提供的文档生成装置的示意图；
[0041]图4是本申请实施例提供的智能设备的结构示意图。
具体实施方式
[0042]下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。
[0043]本申请实施例提供一种文档生成方法、装置、智能设备及存储介质(即计算机可读存储介质)。其中，文档生成方法可以应用于包括文档生成装置，该文档生成装置具体可以集成在智能设备中，该智能设备可以与服务器或终端等进行通信连接，该服务器可以是独立的物理服务器，也可以是多个物理服务器构成的服务器集群或者分布式系统，还可以是提供云服务、云数据库、云计算、云函数、云存储、网络服务、云通信、中间件服务、域名服务、安全服务、内容分发网络(Content Delivery Network，CDN)、以及大数据和人工智能平台等基础云计算服务的云服务器，但并不局限于此。服务器与终端之间可以通过有线或无线通信方式进行直接或间接地连接，本申请在此不做限制。该终端可以是手机、计算机电脑、pad、家电设备或者可穿戴设备等。
[0044]以下分别进行详细说明。需说明的是，以下实施例的描述顺序不作为对实施例优选顺序的限定。
[0045]在本实施例中，将从智能设备的角度进行描述，请参阅图1，图1是本申请一实施例提供的文档生成方法的流程示意图。该文档生成方法可以包括：
[0046]S10、获取编程文件；
[0047]其中，编程文本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种文档生成方法，其特征在于，所述方法包括：获取编程文件；在编译所述编程文件时，解析所述编程文件，得到所述编程文件中的描述符；读取所述编程文件的注释内容；将所述注释内容与所述描述符进行匹配；根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档。2.根据权利要求1所述的文档生成方法，其特征在于，所述将所述注释内容与所述描述符进行匹配，包括：获取所述注释内容中的各个代码注释对应的目标描述符；若所述描述符与所述目标描述符相同，则判定所述描述符与所述注释内容中的代码注释匹配。3.根据权利要求2所述的文档生成方法，其特征在于，所述根据匹配的所述描述符与所述注释内容生成所述编程文件的说明文档，包括：若所述描述符与所述注释内容中的代码注释匹配，则将所述描述符以及与所述描述符匹配的所述代码注释关联写入预设标记文档中，以生成所述编程文件对应的说明文档。4.根据权利要求1所述的文档生成方法，其特征在于，所述解析所述编程文件，得到所述编程文件的描述符包括：获取预设解析工具；根据所述预设解析工具解析所述编程文件，得到所述编程文件的描述符。5.根据权利要求1所述的文档生成方法，其特征在于，所述读取所述编程文件的注释内容，包括：获取预设正则表达式；根据所述预设正则表达式检索编程文件的内容，以读取编程...

【专利技术属性】
技术研发人员：张俊，
申请(专利权)人：深圳TCL新技术有限公司，
类型：发明
国别省市：