组件说明文档生成方法、装置、设备及存储介质制造方法及图纸

本发明专利技术涉及计算机技术领域，公开了一种组件说明文档生成方法、装置、设备及存储介质，该方法包括：接收文档生成指令后，动态读取业务组件模板；对业务组件模板进行语法解析，得到业务组件模板的关键字；将业务组件模板的关键字转换为抽象语法树；根据抽象语法树，生成业务组件说明文档。上述方法可以轻松生成对应的组件说明文档；相比于传统的手动撰写说明文档的方式，这种方法能够极大地减少手动编写说明文档的工作量，提高开发效率，具有更强的拓展和可配置性，同时也能够降低人工操作的出错率。率。率。

【技术实现步骤摘要】
组件说明文档生成方法、装置、设备及存储介质


[0001]本专利技术涉及计算机
，特别是涉及一种组件说明文档生成方法、装置、设备及存储介质。

技术介绍

[0002]随着互联网技术的不断发展，互联网业务需求量也在不断增加，在前端开发过程中，会采用很多框架将业务封装为组件。
[0003]以Vue框架为例，在编写组件时，通常需要将组件的内容提取出来，制成一个组件文档供使用者阅读。虽然.vue、.jsx、.tsx等文件也可以用来展示组件内容，但相比于专业的说明文档，源代码文件的展示方式就不行了，专业的说明文档更加轻量级、格式固定等优势是文档传输和阅读的极佳选择。因此，每个组件的文档文件编写内容几乎一致，大致包含组件名，参数列表、引用方式、代码演示、组件方法展示等。然而，将组件内容逐一提取至文档文件中是一项苦力活，这种做法效率低，出错率也相对较高。
[0004]因此，如何自动生成组件说明文档，是本领域技术人员亟待解决的技术问题。

技术实现思路

[0005]有鉴于此，本专利技术的目的在于提供一种组件说明文档生成方法、装置、设备及存储介质，可以提高开发效率，降低出错率，具有更强的拓展和可配置性。其具体方案如下：
[0006]一种组件说明文档生成方法，包括：
[0007]接收文档生成指令后，动态读取业务组件模板；
[0008]对所述业务组件模板进行语法解析，得到所述业务组件模板的关键字；
[0009]将所述业务组件模板的关键字转换为抽象语法树；
[0010]根据所述抽象语法树，生成业务组件说明文档。
[0011]优选地，在本专利技术实施例提供的上述组件说明文档生成方法中，对所述业务组件模板进行语法解析，得到所述业务组件模板的关键字，包括：
[0012]将所述业务组件模板中的字符串进行分解，得到词法单元；
[0013]从所述词法单元中获取所述业务组件模板的关键字。
[0014]优选地，在本专利技术实施例提供的上述组件说明文档生成方法中，将所述业务组件模板的关键字转换为抽象语法树，包括：
[0015]当所述业务组件模板为Vue组件模板时，使用vue
‑
template
‑
compiler模块将组件模板的关键字转换为抽象语法树。
[0016]优选地，在本专利技术实施例提供的上述组件说明文档生成方法中，根据所述抽象语法树，生成业务组件说明文档，包括：
[0017]遍历所述抽象语法树，对所述抽象语法树进行增删改查操作，生成业务组件的markdown文档。
[0018]优选地，在本专利技术实施例提供的上述组件说明文档生成方法中，在生成业务组件
说明文档之后，还包括：
[0019]根据所述业务组件说明文档的输出地址，判断对应目录下是否存在所述业务组件说明文档；
[0020]若存在，则判断是否覆盖；
[0021]若不存在或判定需要覆盖，则动态拼接输出所述业务组件说明文档。
[0022]优选地，在本专利技术实施例提供的上述组件说明文档生成方法中，所述业务组件说明文档的输出地址与所述业务组件模板的源地址是一一对应的关系。
[0023]优选地，在本专利技术实施例提供的上述组件说明文档生成方法中，还包括：
[0024]若未得到所述业务组件模板的关键字，则直接使用默认配置项将所述业务组件模板解析为对应的抽象语法树。
[0025]本专利技术实施例还提供了一种组件说明文档生成装置，包括：
[0026]模板读取模块，用于接收文档生成指令后，动态读取业务组件模板；
[0027]语法解析模块，用于对所述业务组件模板进行语法解析，得到所述业务组件模板的关键字；
[0028]语法转换模块，用于将所述业务组件模板的关键字转换为抽象语法树；
[0029]文档生成模块，用于根据所述抽象语法树，生成业务组件说明文档。
[0030]本专利技术实施例还提供了一种组件说明文档生成设备，包括处理器和存储器，其中，所述处理器执行所述存储器中存储的计算机程序时实现如本专利技术实施例提供的上述组件说明文档生成方法。
[0031]本专利技术实施例还提供了一种计算机可读存储介质，用于存储计算机程序，其中，所述计算机程序被处理器执行时实现如本专利技术实施例提供的上述组件说明文档生成方法。
[0032]从上述技术方案可以看出，本专利技术所提供的一种组件说明文档生成方法，包括：接收文档生成指令后，动态读取业务组件模板；对业务组件模板进行语法解析，得到业务组件模板的关键字；将业务组件模板的关键字转换为抽象语法树；根据抽象语法树，生成业务组件说明文档。
[0033]本专利技术提供的上述组件说明文档生成方法，通过动态读取业务组件模板，依次进行语法解析和语法转换，得到抽象语法树，根据抽象语法树，轻松生成对应的组件说明文档；相比于传统的手动撰写说明文档的方式，这种方法能够极大地减少手动编写说明文档的工作量，提高开发效率，具有更强的拓展和可配置性，同时也能够降低人工操作的出错率。
[0034]此外，本专利技术还针对组件说明文档生成方法提供了相应的装置、设备及计算机可读存储介质，进一步使得上述方法更具有实用性，该装置、设备及计算机可读存储介质具有相应的优点。
附图说明
[0035]为了更清楚地说明本专利技术实施例或相关技术中的技术方案，下面将对实施例或相关技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本专利技术的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。
[0036]图1为本专利技术实施例提供的组件说明文档生成方法的流程图；
[0037]图2为本专利技术实施例提供的组件说明文档生成方法的框架示意图；
[0038]图3为本专利技术实施例提供的Vue组件模板与对应的组件说明文档的图例示意图；
[0039]图4为本专利技术实施例提供的UI组件模板与对应的UI组件markdown文档的图例示意图；
[0040]图5为本专利技术实施例提供的组件说明文档生成装置的结构示意图。
具体实施方式
[0041]下面将结合本专利技术实施例中的附图，对本专利技术实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本专利技术一部分实施例，而不是全部的实施例。基于本专利技术中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本专利技术保护的范围。
[0042]本专利技术提供一种组件说明文档生成方法，如图1所示，包括以下步骤：
[0043]S101、接收文档生成指令后，动态读取业务组件模板；
[0044]上述步骤中，业务组件模板可以为Vue组件模板、UI组件模板等。在接收到文档生成指令后，可以动态读取Vue组件模板，或，动态读取UI组件模板。
[0045]S102、对业务组件模板进行语法解析，得到业务组件模板的关键字；
[0046]S103、将本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种组件说明文档生成方法，其特征在于，包括：接收文档生成指令后，动态读取业务组件模板；对所述业务组件模板进行语法解析，得到所述业务组件模板的关键字；将所述业务组件模板的关键字转换为抽象语法树；根据所述抽象语法树，生成业务组件说明文档。2.根据权利要求1所述的组件说明文档生成方法，其特征在于，对所述业务组件模板进行语法解析，得到所述业务组件模板的关键字，包括：将所述业务组件模板中的字符串进行分解，得到词法单元；从所述词法单元中获取所述业务组件模板的关键字。3.根据权利要求2所述的组件说明文档生成方法，其特征在于，将所述业务组件模板的关键字转换为抽象语法树，包括：当所述业务组件模板为Vue组件模板时，使用vue
‑
template
‑
compiler模块将组件模板的关键字转换为抽象语法树。4.根据权利要求3所述的组件说明文档生成方法，其特征在于，根据所述抽象语法树，生成业务组件说明文档，包括：遍历所述抽象语法树，对所述抽象语法树进行增删改查操作，生成业务组件的markdown文档。5.根据权利要求4所述的组件说明文档生成方法，其特征在于，在生成业务组件说明文档之后，还包括：根据所述业务组件说明文档的输...

【专利技术属性】
技术研发人员：谭文超，徐辉，吴鹏，李钢，
申请(专利权)人：中电通商数字技术上海有限公司，
类型：发明
国别省市：