[发明专利]一种UI卡片文档的生成方法和装置

说明书

本申请涉及一种UI卡片文档的生成方法，所述方法包括步骤：获取所述UI卡片的描述信息；将所述UI卡片的描述信息按照预设数据格式存储在描述文件中；按照所述预设数据格式解析所述描述文件，得到所述UI卡片的描述信息；根据所述UI卡片的描述信息，生成指定格式的UI卡片文档。此外，还可以使用所述描述文件进行二次开发。借助于本申请的方案，使得UI描述信息的解析更简单准确，更易于基于解析的描述信息生成使用文档或二次开发。

技术领域

本申请涉及信息技术领域，尤其涉及一种UI卡片文档生成方法和装置。

背景技术

UI卡片又叫UI组件，通过将页面拆分成多个UI组件，可以提高UI组件的复用效率，提高代码重复利用率，降低开发成本；每个UI组件都用来展示页面中的一小部分，具体UI组件对应页面中哪个区域以及区域大小由开发UI组件的人员来负责设计，比较灵活；现代前端领域开发页面基本都是通过开发UI组件然后通过UI组件组合拼装的方式构建出完整的页面提供给用户浏览使用。每个UI卡片都需要1个使用文档来描述卡片的详细使用信息，同时还将开发卡片平台，卡片平台上需要获取所有卡片的详细信息，以便利用这些卡片信息支持用户以一种可视化的方式拖拽卡片直接设计出页面。

现代前端领域基本都在使用UI卡片拼装页面的方案，一方面，开发UI卡片需要编写对应的使用文档供使用卡片的人浏览阅读；另一方面，编写卡片使用文档的语言也多种多样，比如markdown，html等等，都可以描述出卡片的使用信息，方便卡片使用者阅读。

上述方式存在的缺点是，只能生成对应的卡片使用文档给人观看，对其它程序模块解析卡片的详细使用信息极其不友好，造成了其它程序模块解析卡片的详细使用信息时难度大，成本高，解析准确率偏低等问题。

发明内容

本申请的目的是提供一种UI卡片文档生成方法和装置，以解决现有技术中解析UI卡片的详细信息难度大、成本高、解析准确率低的问题。

为达到上述目的，本申请提供了一种UI卡片文档的生成方法，所述方法包括步骤：获取所述UI卡片的描述信息；将所述UI卡片的描述信息按照预设数据格式存储在描述文件中；按照所述预设数据格式解析所述描述文件，得到所述UI卡片的描述信息；根据所述UI卡片的描述信息，生成指定格式的UI卡片文档。

进一步地，所述方法还包括：预先设置所述描述文件的数据格式，其中所述数据格式与所述UI卡片的描述信息相匹配。

进一步地，所述方法还包括：当接收到调用所述UI卡片的请求时，按照所述预设数据格式解析所述UI卡片的所述描述文件，得到所述UI卡片的描述信息；根据所述UI卡片的描述信息，在指定页面中构建所述UI卡片展示效果。

进一步地，所述方法还包括：预先定义构建所述UI卡片展示效果所需的描述信息的类别；根据所述描述信息的类别，预先设置所述描述文件的数据格式。

进一步地，所述方法还包括：所述UI卡片的描述信息包括：UI卡片名、参数名、参数类型、参数默认值和UI卡片说明中的一种或多种。

本申请还提供了一种UI卡片文档的生成装置，该装置包括获取模块、存储模块、解析模块和生成模块；

所述获取模块，用于获取所述UI卡片的描述信息；

所述存储模块，用于将所述UI卡片的描述信息按照预设数据格式存储在描述文件中；

所述解析模块，用于按照所述预设数据格式解析所述描述文件，得到所述UI卡片的描述信息；

所述生成模块，用于根据所述UI卡片的描述信息，生成指定格式的UI卡片文档。

进一步地，所述装置还包括第一设置模块，用于预先设置所述描述文件的数据格式，其中所述数据格式与所述UI卡片的描述信息相匹配。

进一步地，所述装置还包括构建模块；