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

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

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


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

技术介绍

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

技术实现思路

[0005]有鉴于此，本专利技术的目的在于提供一种组件说明文档生成方法、装置本文档来自技高网...

【技术保护点】

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

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