[发明专利]一种组件示例页面编译方法及装置

说明书

本申请提供一种组件示例页面编译方法及装置，应用于计算技术领域。根据组件示例页面与Markdown格式的组件文档的映射关系文件，获取目标组件示例页面对应的Markdown格式的目标组件文档；将所述目标组件文档转换成组件文档html片段；将所述组件文档html片段插入所述目标组件示例页面，完成所述目标组件示例页面的编译。如此，将与目标示例页面对应的Markdown格式的目标组件文档转换成组件文档html片段，然后自动将组件文档html片段插入到目标组件示例页面，以完成目标组件文档和目标组件示例页面的整合，能够提高目标组件示例页面的编译效率。

技术领域

本申请涉及计算机技术领域，具体涉及一种组件示例页面编译方法及装置。

背景技术

目前，由组件开发者将组件文档和组件示例以固定的语法写在Markdown文档，再直接编译成Web应用代码；或者将组件文档的内容以固定的语法写在组件实现代码中，再生成Markdown文档，编译成Web应用代码。

但是对于已存在组件示例页面，但不存在组件文档的情况，可以先将组件示例页面拆分，并迁移到Markdown文档或组件实现代码中；也可以在组件示例页面中手动维护组件文档。但是目前的方法耗费的时间较长，组件文档与组件示例页面的整合效率较低，导致组件示例页面的编译效率较低。

发明内容

有鉴于此，本申请提供一种组件示例页面编译方法及装置，能够提高组件文档与组件示例页面的整合效率，进一步提高组件示例页面的编译效率。

为解决上述问题，本申请提供的技术方案如下：

第一方面，本申请提供一种组件示例页面编译方法，所述方法包括：

根据组件示例页面与Markdown格式的组件文档的映射关系文件，获取目标组件示例页面对应的Markdown格式的目标组件文档；

将所述目标组件文档转换成组件文档html片段；

将所述组件文档html片段插入所述目标组件示例页面，完成所述目标组件示例页面的编译。

在一种可能实现的方式中，所述方法还包括：

根据组件示例页面的目录和文件名称获取组件实现代码；

从所述组件实现代码中提取组件文档内容；

根据所述组件文档内容生成Markdown格式的组件文档；

生成所述组件示例页面与所述Markdown格式的组件文档的映射关系文件。

在一种可能实现的方式中，所述从所述组件实现代码中提取组件文档内容，包括：

根据注释数据从所述组件实现代码中提取所述组件文档内容，所述注释数据包括组件的名称、属性、事件、插槽和外部可调用的方法。

在一种可能实现的方式中，所述将所述组件文档html片段插入所述目标组件示例页面，包括：

根据组件实现代码将所述组件文档html片段插入所述目标组件示例页面的预设位置。

在一种可能实现的方式中，若所述目标组件文档为特殊组件文档，所述方法还包括：

手动维护所述特殊组件文档和特殊组件示例页面的特殊映射关系，所述特殊组件文档为无法生成Markdown格式的组件文档。

第二方面，本申请提供一种组件示例页面编译装置，所述装置包括：

获取模块，用于根据组件示例页面与Markdown格式的组件文档的映射关系文件，获取目标组件示例页面对应的Markdown格式的目标组件文档；

转换模块，用于将所述目标组件文档转换成组件文档html片段；