一种UI卡片文档的生成方法和装置制造方法及图纸

本申请涉及一种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卡片的描述信息相匹配。进一步地，所述装置还包括构建模块；所述解析模块，还用于当接收到调用所述UI卡片的请求时，按照所述预设数据格式解析所述UI卡片的所述描述文件，得到所述UI卡片的描述信息；所述构建模块，用于根据所述UI卡片的描述信息，在指定页面中构建所述UI卡片展示效果。进一步地，所述装置还包括定义模块和第二设置模块；所述定义模块，用于预先定义构建所述UI卡片展示效果所需的描述信息的类别；所述第二设置模块，用于根据所述描述信息的类别，预先设置所述描述文件的数据格式。进一步地，所述UI卡片的描述信息包括：UI卡片名、参数名、参数类型、参数默认值和UI卡片说明中的一种或多种。本申请还提供了一种电子设备，所述设备包括：存储装置和一个或多个处理器；其中，存储装置用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现上述的一种UI卡片文档的生成方法。本申请还提供了一种计算机程序产品，包括计算机程序指令，当所述指令由处理器执行时，用于实现上述的一种UI卡片文档的生成方法。本申请还提供了一种计算机可读存储介质，其上存储有计算机程序，当所述计算机程序被执行时，实现上述的一种UI卡片文档的生成方法。相比于现有技术中的方式，本申请提供的一种UI卡片文档的生成方法和装置，不直接编写卡片使用文档，而是以对程序解析更简单准确的特定的数据格式来记录卡片的详细信息，以此满足其它依赖卡片详细信息工作的程序模块或产品的需求。至于UI卡片的使用文档，可以提前基于所设计的UI卡片的特定的数据格式开发工具自动生成对应的UI卡片使用文档，这样既可以实现卡片的使用文档满足卡片使用者阅读，描述卡片详细信息的特定的数据格式对依赖卡片详细信息的其它程序模块解析来说又足够的简单易行，识别准确。附图说明为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。图1是本申请的一种UI卡片文档的生成方法的流程示意图。图2是本申请的一种UI卡片的描述信息的二次开发利用的流程示意图。图3是本申请的一种UI卡片文档的生成装置的模块组成示意图。具体实施方式为了便于本领域普通技术人员理解和实施本申请，下面结合附图对本申请的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。实施例一参阅图1，本申请实施例一提供了一种UI卡片文档的生成方法，该方法包括如下步骤：(1)获取所述UI卡片的描述信息。根据业务情况来确定UI卡片开发数量的多少，开发UI卡片就是使用前端相关技术，比如React等前端框架按照业务约定开发出对应的UI卡片，1个UI卡片代表页面中的特定部分，通过多个UI卡片的组合拼装可以构建出完整的页面。在开发所述UI卡片的同时，要编写和记录所述UI卡片对应的描述信息，本实施例在进行下述步骤之前，要预先获取所述编写和记录的所述UI卡片对应的描述信息。(2)将所述UI卡片的描述信息按照预设数据格式存储在描述文件中。在步骤(1)预先获取所述UI卡片的描述信息后，要将所述预先获取的描述信息按照预设数据格式存储在所述描述文件中。进一步地，所述描述文件可以是json数据格式的json文件，可以使用json数据格式来记录所述UI卡片的描述信息，将所述UI卡片的描述信息按照json数据格式存储在j本文档来自技高网...

【技术保护点】
1.一种UI卡片文档的生成方法，其特征在于，所述方法包括步骤：/n获取所述UI卡片的描述信息；/n将所述UI卡片的描述信息按照预设数据格式存储在描述文件中；/n按照所述预设数据格式解析所述描述文件，得到所述UI卡片的描述信息；根据所述UI卡片的描述信息，生成指定格式的UI卡片文档。/n

【技术特征摘要】
1.一种UI卡片文档的生成方法，其特征在于，所述方法包括步骤：
获取所述UI卡片的描述信息；
将所述UI卡片的描述信息按照预设数据格式存储在描述文件中；
按照所述预设数据格式解析所述描述文件，得到所述UI卡片的描述信息；根据所述UI卡片的描述信息，生成指定格式的UI卡片文档。


2.根据权利要求1所述的方法，其特征在于，还包括：
预先设置所述描述文件的数据格式，其中所述数据格式与所述UI卡片的描述信息相匹配。


3.根据权利要求1所述的方法，其特征在于，还包括：
当接收到调用所述UI卡片的请求时，按照所述预设数据格式解析所述UI卡片的所述描述文件，得到所述UI卡片的描述信息；
根据所述UI卡片的描述信息，在指定页面中构建所述UI卡片展示效果。


4.根据权利要求3所述的方法，其特征在于，还包括：
预先定义构建所述UI卡片展示效果所需的描述信息的类别；
根据所述描述信息的类别，预先设置所述描述文件的数据格式。


5.根据权利要求1至4任一项所述的方法，其特征在于：
所述UI卡片的描述信息包括：UI卡片名、参数名、参数类型、参数默认值和UI卡片说明中的一种或多种。


6.一种UI卡片文档的生成装置，其特征在于，该装置包括获取模块、存储模块、解析模块和生成模块；
所述获取模块，用于获取所述UI卡片的描述信息；
所述存储模块，用于将所述UI卡片的描述信息按照预设数据格式存储在描述文件中；
所述解析模块，用于按照所述预设数据格式解析所述描述文件，得到所述UI卡片的描述信息；
所述生成模块，用于根据所述UI卡片的描述信息，生成指定格式的UI卡片文档。

<...

【专利技术属性】
技术研发人员：程水强，
申请(专利权)人：阿里巴巴集团控股有限公司，
类型：发明
国别省市：开曼群岛;KY