[发明专利]H5工程文件的说明文档生成方法、装置和计算机设备

说明书

本申请揭示了一种H5工程文件的说明文档生成方法、装置、计算机设备和存储介质，所述方法包括：遍历第一H5工程文件和第二H5工程文件，提取第一H5工程文件和第二H5工程文件中的注释内容，并根据注释内容生成第一说明文档及第二说明文档；计算出第一说明文档的节点的文字内容与第二说明文档的节点的文字内容的相似度；若相似度大于预设阈值，则将对应的第一说明文档的节点及所述第二说明文档的节点分别标记为第一相似节点及第二相似节点；以第一相似节点至第一说明文档的根节点的路径为第一枝干，及以第二相似节点至第二说明文档的根节点的路径为第二枝干，生成具有树形结构的目标说明文档。有助于代码优化、提高代码开发人员的代码水平。

技术领域

本申请涉及到计算机领域，特别是涉及到一种H5工程文件的说明文档生成方法、装置、计算机设备和存储介质。

背景技术

代码工程文件中，有一些代码实现相同或相似的功能。虽然在代码工程文件中，对于部分代码可能会有注释说明，便于代码开发人员检查工程文件中的代码。但是这些注释说明仅存在于相应的代码处，难以与其他相类似的代码进行比较。尤其在不同工程文件中，实现相同或相似功能的代码可能有多种，其中有优有劣，代码开发人员若能对这些相同或相似功能的代码进行查看比较，必然能提高代码水平。即，现有技术中缺少将具有相同或相似功能的代码的注释内容统一收集起来的技术方案。

发明内容

本申请的主要目的为提供一种H5工程文件的说明文档生成方法、装置、计算机设备和存储介质，旨在生成具有将相同或相似功能的代码的注释内容统一收集起来的说明文档。

为了实现上述发明目的，本申请提出一种H5工程文件的说明文档生成方法，包括以下步骤：

遍历第一H5工程文件和第二H5工程文件，提取所述第一H5工程文件和第二H5工程文件中的注释内容，并根据所述注释内容生成第一说明文档及第二说明文档，其中第一说明文档指第一H5工程文件的树形结构说明文档，第二说明文档指第二H5工程文件的树形结构说明文档；

采用相似度算法，计算出所述第一说明文档的节点的文字内容与所述第二说明文档的节点的文字内容的相似度；

若所述相似度大于预设阈值，则将对应的所述第一说明文档的节点及所述第二说明文档的节点分别标记为第一相似节点及第二相似节点；

以所述第一相似节点至第一说明文档的根节点的路径为第一枝干，及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干，生成具有树形结构的目标说明文档。

进一步地，所述遍历第一H5工程文件和第二H5工程文件，提取所述第一H5工程文件和第二H5工程文件中的注释内容，并根据所述注释内容生成第一说明文档及第二说明文档，其中第一说明文档指第一H5工程文件的树形结构说明文档，第二说明文档指第二H5工程文件的树形结构说明文档的步骤，包括：

在所述第一H5工程文件中查询多个级别的注释标识符，获取多个级别的第一注释内容；

根据所述第一注释内容对应的级别，以所述第一注释内容作为多个级别节点，生成具有层级结构的第一说明文档；

以及，在所述第二H5工程文件中查询多个级别的注释标识符，获取多个级别的第二注释内容；

根据所述第二注释内容对应的级别，以所述第二注释内容作为多个级别节点，生成具有层级结构的第二说明文档。

进一步地，所述采用相似度算法，计算出所述第一说明文档的节点的文字内容与所述第二说明文档的节点的文字内容的相似度的步骤包括：

采用公式：