[发明专利]用于生成信息的方法和装置

说明书

本公开实施例公开了用于生成信息的方法和装置。该方法的一具体实施方式包括：对接收的用户界面组件中包括的模板和脚本进行解析，得到上述用户界面组件的说明信息；根据上述说明信息，生成Markdown文档；获取上述用户界面组件的示例和示例源码；将基于上述示例建立的示例标签字符串和上述示例源码写入上述Markdown文档，得到针对上述用户界面组件的说明文档。该实施方式实现了UI组件说明文档的自动生成，提高了信息生成效率。同时，使生成的说明文档可以实现对示例的渲染和对示例源码的显示。

技术领域

本公开实施例涉及计算机技术领域，具体涉及用于生成信息的方法和装置。

背景技术

随着前端技术日新月异的发展，前端组件化开发也得到了较大的进步。随着一套UI(User Interface，用户界面)组件库的实现，一般，需要提供UI组件库中各UI组件的说明文档，以便开发者可以快速基于UI组件库实现前端页面的业务功能。另外，如果UI组件的说明文档可以提供UI组件相关的示例渲染和对应的源代码供开发者阅览，可以大大提升开发效率。现阶段，通常采用手动撰写的方式生成UI组件的说明文档。然而，手段撰写的方式不仅成本高、效率低，还可能存在由于多人参与撰写而造成的风格不统一问题。

发明内容

本公开实施例提出了用于生成信息的方法和装置。

第一方面，本公开实施例提供了一种用于生成信息的方法，该方法包括：对接收的用户界面组件中包括的模板和脚本进行解析，得到上述用户界面组件的说明信息；根据上述说明信息，生成Markdown文档；获取上述用户界面组件的示例和示例源码；将基于上述示例建立的示例标签字符串和上述示例源码写入上述Markdown文档，得到针对上述用户界面组件的说明文档。

在一些实施例中，上述获取上述用户界面组件的示例和示例源码，包括：根据上述用户界面组件的标识，从预先建立的配置文件中包含的至少一条配置信息中确定目标配置信息，其中，上述目标配置信息包括目标示例，上述目标示例包括示例源码标识；根据上述示例源码标识，从预先设定的示例源码集合获取目标示例源码；将上述目标示例和上述目标示例源码作为上述用户界面组件对应的示例和示例源码。

在一些实施例中，上述配置文件中包含的配置信息包括示例标识；以及上述根据上述用户界面组件的标识，从预先建立的配置文件中包含的至少一条配置信息中确定目标配置信息，包括：确定上述配置文件中是否包括示例标识与上述用户界面组件的标识相匹配的配置信息；响应于确定包括，将上述配置文件中示例标识与上述用户界面组件的标识相匹配的配置信息确定为目标配置信息。

在一些实施例中，上述对接收的用户界面组件中包括的模板和脚本进行解析，得到上述用户界面组件的说明信息，包括：将上述模板和上述脚本解析为抽象语法树；基于上述抽象语法树，获取上述用户界面组件的说明信息。

在一些实施例中，上述示例包括至少一个子示例，上述至少一个子示例用于展示上述用户界面组件在不同场景的状态。

第二方面，本公开实施例提供了一种用于生成信息的装置，装置包括：解析单元，被配置成对接收的用户界面组件中包括的模板和脚本进行解析，得到上述用户界面组件的说明信息；生成单元，被配置成根据上述说明信息，生成Markdown文档；获取单元，被配置成获取上述用户界面组件的示例和示例源码；写入单元，被配置成将基于上述示例建立的示例标签字符串和上述示例源码写入上述Markdown文档，得到针对上述用户界面组件的说明文档。

在一些实施例中，上述获取单元包括：第一确定单元，被配置成根据上述用户界面组件的标识，从预先建立的配置文件中包含的至少一条配置信息中确定目标配置信息，其中，上述目标配置信息包括目标示例，上述目标示例包括示例源码标识；源码获取单元，被配置成根据上述示例源码标识，从预先设定的示例源码集合获取目标示例源码；第二确定单元，被配置成将上述目标示例和上述目标示例源码作为上述用户界面组件对应的示例和示例源码。