CN111507079A

CN111507079A - 一种多语言文档生成方法及系统和设备

Info

Publication number: CN111507079A
Application number: CN202010270903.7A
Authority: CN
Inventors: 房栋
Original assignee: Hangzhou Tuya Information Technology Co Ltd
Current assignee: Hangzhou Tuya Information Technology Co Ltd
Priority date: 2020-04-08
Filing date: 2020-04-08
Publication date: 2020-08-07
Anticipated expiration: 2040-04-08
Also published as: CN111507079B

Abstract

本发明涉及一种移动端应用的多语言文档生成方法，包括以下步骤：获取构成所述移动端应用的所有组件；根据各个所述组件之间的依赖关系生成对应每个所述组件的多个有向图；遍历每个所述有向图、并根据所述移动端应用的api列表生成对应每个所述组件的描述文件；根据预设语言注释规则生成对应所述描述文件的不同语言注释，得到多语言文档。本发明提供的技术方案能够一次性生成对应多个语言版本的注释文档。

Description

一种多语言文档生成方法及系统和设备

技术领域

本发明涉及多语言配置技术领域，尤其涉及一种移动端应用的多语言文档生成方法及其系统、计算机可读存储介质和计算机设备。

背景技术

在移动端开发领域里，每个技术平台都会有自己的文档生成工具，可以通过我们的代码生成对应的技术文档，我们在开发代码的时候经常需要些很多使用文档与api文档给同事或者其他开发者使用，更多的时候我们为了支持的不同的人群我们又会写多种不同语言的版本，每次写代码都需要同时修改我们的文档，文档多以API接口说明的形式提供，展示方式多数是html的形式，整体风格模式都有各自平台各自的风格。

1.现有的技术无法一下子支持多种语言的文档同时生产

2.现有技术产出的风格固定，无法根据自己的喜好产出自己喜欢的风格，风格无法自由改动

3.无法产出UML图，产出的文档只是固定的将api罗列出来，代码的调用关系，所属关系无法表现

4.现有技术都是以整个代码工程为一个整体去处理，不支持现在我们组件化后的移动端代码以每个模块为维度进行模块关系图的展示。

发明内容

本发明旨在至少解决现有技术或相关技术中存在的技术问题之一。

为此，本发明的目的在于提供一种移动端应用的多语言文档生成方法及其系统、计算机可读存储介质和计算机设备，其能够一次性生成对应多个语言版本的注释文档。

为实现上述目的，本发明第一方面的技术方案提供了一种移动端应用的多语言文档生成方法，包括以下步骤：

获取构成移动端应用的所有组件；

根据各个组件之间的依赖关系生成对应每个组件的多个有向图；

遍历每个有向图、并根据移动端应用的api列表生成对应每个组件的描述文件；

根据预设语言注释规则生成对应描述文件的不同语言注释，得到多语言文档。

在上述技术方案中，优选地，根据各个组件之间的依赖关系生成对应每个组件的多个有向图，包括以下步骤：

根据各个组件中的类之间的依赖关系生成Node节点；

根据Node节点生成对应每个组件的多个有向图。

在上述任一技术方案中，优选地，预设语言注释规则为^表示多语言文字开头，$表示多语言文字结尾。

在上述任一技术方案中，优选地，还包括以下步骤：

获取预配置的多语言模板；

根据多语言文档模板将多语言文档分成多个多语言分文档；

其中，每个多语言分文档为可配置文档，多语言模板包括文件模板、方法模板、参数模板、参数选项模板、返回值模板和模块模板中的至少一种。

本发明第二方面的技术方案提供了一种移动端应用的多语言文档生成系统，包括：

获取模块，被设置为用于获取构成移动端应用的所有组件；

有向图生成模块，被设置为用于根据各个组件之间的依赖关系生成对应每个组件的多个有向图；

描述文件生成模块，被设置为用于遍历每个有向图、并根据移动端应用的api列表生成对应每个组件的描述文件；

多语言注释模块，被设置为用于根据预设语言注释规则生成对应描述文件的不同语言注释，得到多语言文档。

在上述技术方案中，优选地，有向图生成模块包括：

Node节点生成单元，被设置为用于根据各个组件中的类之间的依赖关系生成Node节点；

有向图生成单元，被设置为用于根据Node节点生成对应每个组件的多个有向图。

在上述任一技术方案中，优选地，还包括：

语言模板配置模块，被设置为用于配置多语言模板；

文档拆分模块，被设置为用于根据多语言文档模板将多语言文档分成多个多语言分文档；

本发明第三方面的技术方案提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现上述第一方面的任一技术方案提供的基于非接触式的语音交互方法的步骤。

本发明第四方面的技术方案提供了一种计算机设备，包括存储介质和处理器；存储介质，用于存储计算机程序；处理器，用于执行计算机程序以实现上述第一方面的任一技术方案提供的基于非接触式的语音交互方法的步骤。

本发明提供的移动端应用的多语言文档生成方法及其系统、计算机可读存储介质和计算机设备与现有技术相比的优点在于，解决了现有技术中的以下问题：1、需要一次性生成多份文档；2、需要定义并实现一种规则在api注释支持多语言注释的输入；3、解析代码间的调用关系，分析代码的属性与方法与被使用的情况；4、支持自定义文档风格；5、在客户端自动化平台，自动发布或者构建代码时需要同时产出对应代码版本的文档出来。

附图说明

本发明的上述和/或附加的方面和优点从结合下面附图对实施例的描述中将变得明显和容易理解，其中：

图1示出了本发明第一个实施例所涉及多语言文档生成方法的流程框图；

图2示出了本发明第二个实施例所涉及多语言文档生成方法的流程框图；

图3示出了本发明第三个实施例所涉及多语言文档生成方法的流程框图；

图4示出了本发明第四个实施例所涉及多语言文档生成方法的流程框图；

图5示出了本发明第五个实施例所涉及多语言文档生成系统的结构框图；

图6示出了本发明第六个实施例所涉及多语言文档生成系统的结构框图；

图7示出了本发明第七个实施例所涉及多语言文档生成系统的结构框图；

图8示出了本发明第八个实施例所涉及多语言文档生成系统的结构框图。

具体实施方式

为了能够更清楚地理解本发明的上述目的、特征和优点，下面结合附图和具体实施方式对本发明进行进一步的详细描述。需要说明的是，在不冲突的情况下，本申请的实施例及实施例中的特征可以相互组合。

在下面的描述中阐述了很多具体细节以便于充分理解本发明，但是，本发明还可以采用其他不同于在此描述的其他方式来实施，因此，本发明的保护范围并不限于下面公开的具体实施例的限制。

下面参照图1至图8描述根据本发明一些实施例的移动端应用的多语言文档生成方法及其系统、计算机可读存储介质和计算机设备。

如图1所示，按照本发明第一个实施例的移动端应用的多语言文档生成方法，包括以下步骤：

S1，获取构成移动端应用的所有组件；

S2，根据各个组件之间的依赖关系生成对应每个组件的多个有向图；

在该步骤中，每个组件与被依赖的组件，因为是一对多的关系，就是一颗二叉树的结构，因为某个被依赖的组件，也会被其他组件依赖，当我们把全部的组件依赖放在一起时，就可以把这个依赖关系看成一个有向图。

S3，遍历每个有向图、并根据移动端应用的api列表生成对应每个组件的描述文件；

在该步骤中，通过读取移动端应用的对应各个组件的描述文件获取所描述的代码，如：iOS组件以podspec的方式提供，除了组件描述文件同时可以支持使用者指定本地的文件路径直接进行代码扫描分析。

S4，根据预设语言注释规则生成对应描述文件的不同语言注释，得到多语言文档。

在该步骤中，每一个有向图可以通过正则表达式去具体匹配每个组件中的每一个方法或变量等，并且读取api列表，获取文件说明，获取类说明，获取模块说明并且按照前面定义的多语言描述规则获取不同语言的注释。

如图2所示，按照本发明第二个实施例的移动端应用的多语言文档生成方法，包括以下步骤：

S1，获取构成移动端应用的所有组件；

S21，根据各个组件中的类之间的依赖关系生成Node节点；

S22，根据Node节点生成对应每个组件的多个有向图；

在该步骤中，只要某个组件中的某个类被另一个类使用了，那么便产生了一个Node节点，每一个Node节点代表一个类的描述与引用，这样每一个组件便会生成多个有向图，再将每个组件的每个有向图进行分析(通过深度遍历每一个有向图，查找每一个节点)，就可以组件为维度产出多个有向图

如图3所示，按照本发明第三个实施例的移动端应用的多语言文档生成方法，包括以下步骤：

S1，获取构成移动端应用的所有组件；

S4，根据预设语言注释规则生成对应描述文件的不同语言注释，得到多语言文档；

S5，获取预配置的多语言模板；

S6，根据多语言文档模板将多语言文档分成多个多语言分文档；

在该步骤中，每一个多语言分文档均是开放的模板，个人可以根据喜好修改，我们也可以提供多个风格的模板。

如图4所示，按照本发明第四个实施例的移动端应用的多语言文档生成方法，包括以下步骤：

S1，获取构成移动端应用的所有组件；

S21，根据各个组件中的类之间的依赖关系生成Node节点；

S22，根据Node节点生成对应每个组件的多个有向图；

S5，获取预配置的多语言模板；

如图5所示，按照本发明第五个实施例的移动端应用的多语言文档生成系统100，包括：

获取模块10，被设置为用于获取构成移动端应用的所有组件；

有向图生成模块20，被设置为用于根据各个组件之间的依赖关系生成对应每个组件的多个有向图；

描述文件生成模块30，被设置为用于遍历每个有向图、并根据移动端应用的api列表生成对应每个组件的描述文件；

多语言注释模块40，被设置为用于根据预设语言注释规则生成对应描述文件的不同语言注释，得到多语言文档。

如图6所示，按照本发明第六个实施例的移动端应用的多语言文档生成系统100，包括：

Node节点生成单元21，被设置为用于根据各个组件中的类之间的依赖关系生成Node节点；

有向图生成单元22，被设置为用于根据Node节点生成对应每个组件的多个有向图；

如图7所示，按照本发明第七个实施例的移动端应用的多语言文档生成系统100，包括：

多语言注释模块40，被设置为用于根据预设语言注释规则生成对应描述文件的不同语言注释，得到多语言文档；

语言模板配置模块50，被设置为用于配置多语言模板；

文档拆分模块60，被设置为用于根据多语言文档模板将多语言文档分成多个多语言分文档；

如图8所示，按照本发明第八个实施例的移动端应用的多语言文档生成系统100，包括：

语言模板配置模块50，被设置为用于配置多语言模板；

在上述任一实施例中，优选地，预设语言注释规则为^表示多语言文字开头，$表示多语言文字结尾。

在该实施例中，移动端应用的多语言注释以zh^表示中文开头，zh$表示中文结尾，en^表示英文开始，en$表示英文结束，其他语言以此类推，^符号表示开始，$符号表示结束，从而支持多语言的注释。

在上述任一实施例中，优选地，移动端应用为ios端应用或安卓端应用。

基于上述如图1至图4所示方法，相应的，本申请实施例还提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现上述任一实施例的移动端应用的多语言文档生成方法的步骤。

基于这样的理解，本申请的技术方案可以以软件产品的形式体现出来，该软件产品可以存储在一个非易失性存储介质(可以是CD-ROM，U盘，移动硬盘等)中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本申请各个实施场景的方法。

基于上述如图1至图4所示的方法，以及图5至图8所示的虚拟装置实施例，为了实现上述目的，本申请实施例还提供了一种计算机设备，包括存储介质和处理器；存储介质，用于存储计算机程序；处理器，用于执行计算机程序以实现上述任一实施例的移动端应用的多语言文档生成方法的步骤。

可选地，该计算机设备还可以包括用户接口、网络接口、摄像头、射频(RadioFrequency，RF)电路，传感器、音频电路、WI-FI模块等等。用户接口可以包括显示屏(Display)、输入单元比如键盘(Keyboard)等，可选用户接口还可以包括USB接口、读卡器接口等。网络接口可选的可以包括标准的有线接口、无线接口(如蓝牙接口、WI-FI接口)等。

本领域技术人员可以理解，本实施例提供的一种计算机设备结构并不构成对该计算机设备的限定，可以包括更多或更少的部件，或者组合某些部件，或者不同的部件布置。

存储介质中还可以包括操作系统、网络通信模块。操作系统是管理和保存计算机设备硬件和软件资源的程序，支持信息处理程序以及其它软件和/或程序的运行。网络通信模块用于实现存储介质内部各组件之间的通信，以及与该实体设备中其它硬件和软件之间通信。

在本说明书的描述中，术语“一个实施例”、“一些实施例”、“具体实施例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或特点包含于本发明的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不一定指的是相同的实施例或实例。而且，描述的具体特征、结构、材料或特点可以在任何的一个或多个实施例或示例中以合适的方式结合。

以上所述仅为本发明的优选实施例而已，并不用于限制本发明，对于本领域的技术人员来说，本发明可以有各种更改和变化。凡在本发明的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims

1.一种移动端应用的多语言文档生成方法，其特征在于，包括以下步骤：

获取构成所述移动端应用的所有组件；

根据各个所述组件之间的依赖关系生成对应每个所述组件的多个有向图；

遍历每个所述有向图、并根据所述移动端应用的api列表生成对应每个所述组件的描述文件；

根据预设语言注释规则生成对应所述描述文件的不同语言注释，得到多语言文档。

2.根据权利要求1所述的多语言文档生成方法，其特征在于，根据各个所述组件之间的依赖关系生成对应每个所述组件的多个有向图，包括以下步骤：

根据各个所述组件中的类之间的所述依赖关系生成Node节点；

根据所述Node节点生成对应每个所述组件的多个所述有向图。

3.根据权利要求1或2所述的多语言文档生成方法，其特征在于：所述预设语言注释规则为^表示多语言文字开头，$表示多语言文字结尾。

4.根据权利要求1或2所述的多语言文档生成方法，其特征在于，还包括以下步骤：

获取预配置的多语言模板；

根据所述多语言文档模板将所述多语言文档分成多个多语言分文档；

其中，每个所述多语言分文档为可配置文档，所述多语言模板包括文件模板、方法模板、参数模板、参数选项模板、返回值模板和模块模板中的至少一种。

5.一种移动端应用的多语言文档生成系统，其特征在于，包括：

获取模块，被设置为用于获取构成所述移动端应用的所有组件；

有向图生成模块，被设置为用于根据各个所述组件之间的依赖关系生成对应每个所述组件的多个有向图；

描述文件生成模块，被设置为用于遍历每个所述有向图、并根据所述移动端应用的api列表生成对应每个所述组件的描述文件；

多语言注释模块，被设置为用于根据预设语言注释规则生成对应所述描述文件的不同语言注释，得到多语言文档。

6.根据权利要求5所述的多语言文档生成系统，其特征在于，所述有向图生成模块包括：

Node节点生成单元，被设置为用于根据各个所述组件中的类之间的所述依赖关系生成Node节点；

有向图生成单元，被设置为用于根据所述Node节点生成对应每个所述组件的多个所述有向图。

7.根据权利要求5或6所述的多语言文档生成系统，其特征在于：所述预设语言注释规则为^表示多语言文字开头，$表示多语言文字结尾。

8.根据权利要求5或6所述的多语言文档生成系统，其特征在于，还包括：

语言模板配置模块，被设置为用于配置多语言模板；

文档拆分模块，被设置为用于根据所述多语言文档模板将所述多语言文档分成多个多语言分文档；

9.一种计算机可读存储介质，其特征在于，其上存储有计算机程序，该程序被处理器执行时实现如权利要求1至4中任一项所述的移动端应用的多语言文档生成方法的步骤。

10.一种计算机设备，其特征在于，包括存储介质和处理器；存储介质，用于存储计算机程序；处理器，用于执行计算机程序以实现如权利要求1至4中任一项所述的移动端应用的多语言文档生成方法的步骤。