H5工程文件的说明文档生成方法、装置和计算机设备.pdf

上传人:奶盖 文档编号:11457416 上传时间:2021-09-27 格式:PDF 页数:19 大小:658.74KB
收藏 版权申诉 举报 下载
H5工程文件的说明文档生成方法、装置和计算机设备.pdf_第1页
第1页 / 共19页
H5工程文件的说明文档生成方法、装置和计算机设备.pdf_第2页
第2页 / 共19页
H5工程文件的说明文档生成方法、装置和计算机设备.pdf_第3页
第3页 / 共19页
文档描述:

《H5工程文件的说明文档生成方法、装置和计算机设备.pdf》由会员分享,可在线阅读,更多相关《H5工程文件的说明文档生成方法、装置和计算机设备.pdf(19页完成版)》请在专利查询网上搜索。

1、(19)中华人民共和国国家知识产权局 (12)发明专利申请 (10)申请公布号 (43)申请公布日 (21)申请号 201910218771.0 (22)申请日 2019.03.21 (71)申请人 平安普惠企业管理有限公司 地址 518000 广东省深圳市前海深港合作 区前湾一路1号A栋201室 (入驻深圳市 前海商务秘书有限公司) (72)发明人 孙志平 (74)专利代理机构 深圳市明日今典知识产权代 理事务所(普通合伙) 44343 代理人 王杰辉 (51)Int.Cl. G06F 17/22(2006.01) G06F 8/33(2018.01) (54)发明名称 H5工程文件的说明文。

2、档生成方法、 装置和计 算机设备 (57)摘要 本申请揭示了一种H5工程文件的说明文档 生成方法、 装置、 计算机设备和存储介质, 所述方 法包括: 遍历第一H5工程文件和第二H5工程文 件, 提取第一H5工程文件和第二H5工程文件中的 注释内容, 并根据注释内容生成第一说明文档及 第二说明文档; 计算出第一说明文档的节点的文 字内容与第二说明文档的节点的文字内容的相 似度; 若相似度大于预设阈值, 则将对应的第一 说明文档的节点及所述第二说明文档的节点分 别标记为第一相似节点及第二相似节点; 以第一 相似节点至第一说明文档的根节点的路径为第 一枝干, 及以第二相似节点至第二说明文档的根 节点。

3、的路径为第二枝干, 生成具有树形结构的目 标说明文档。 有助于代码优化、 提高代码开发人 员的代码水平。 权利要求书3页 说明书13页 附图2页 CN 110110293 A 2019.08.09 CN 110110293 A 1.一种H5工程文件的说明文档生成方法, 其特征在于, 包括: 遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工程文件和第二H5工程文件 中的注释内容, 并根据所述注释内容生成第一说明文档及第二说明文档, 其中第一说明文 档指第一H5工程文件的树形结构说明文档, 第二说明文档指第二H5工程文件的树形结构说 明文档; 采用相似度算法, 计算出所述第一说明文档的。

4、节点的文字内容与所述第二说明文档的 节点的文字内容的相似度; 若所述相似度大于预设阈值, 则将对应的所述第一说明文档的节点及所述第二说明文 档的节点分别标记为第一相似节点及第二相似节点; 以所述第一相似节点至第一说明文档的根节点的路径为第一枝干, 及以所述第二相似 节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形结构的目标说明文档。 2.根据权利要求1所述的H5工程文件的说明文档生成方法, 其特征在于, 所述遍历第一 H5工程文件和第二H5工程文件, 提取所述第一H5工程文件和第二H5工程文件中的注释内 容, 并根据所述注释内容生成第一说明文档及第二说明文档, 其中第一说明文档指第一。

5、H5 工程文件的树形结构说明文档, 第二说明文档指第二H5工程文件的树形结构说明文档的步 骤, 包括: 在所述第一H5工程文件中查询多个级别的注释标识符, 获取多个级别的第一注释内 容; 根据所述第一注释内容对应的级别, 以所述第一注释内容作为多个级别节点, 生成具 有层级结构的第一说明文档; 以及, 在所述第二H5工程文件中查询多个级别的注释标识符, 获取多个级别的第二注 释内容; 根据所述第二注释内容对应的级别, 以所述第二注释内容作为多个级别节点, 生成具 有层级结构的第二说明文档。 3.根据权利要求1所述的H5工程文件的说明文档生成方法, 其特征在于, 所述采用相似 度算法, 计算出所。

6、述第一说明文档的节点的文字内容与所述第二说明文档的节点的文字内 容的相似度的步骤包括: 采用公式: 计算出所述第一说明文档与第二说明文档的节点的文字内容的相似度; 其中 similarity为相似度, A为所述第一说明文档的节点的文字内容的词频向量, B为所述第二 说明文档的节点的文字内容的词频向量, Ai为所述第一说明文档的节点的文字内容的第i 个单词出现的次数, Bi为所述第二说明文档的节点的文字内容的第i个单词出现的次数。 4.根据权利要求3所述的H5工程文件的说明文档生成方法, 其特征在于, 所述采用公 式: 权利要求书 1/3 页 2 CN 110110293 A 2 计算出所述第一。

7、说明文档与第二说明文档的节点的文字内容的相似度的步骤之前, 包 括: 对所述第一说明文档与第二说明文档的节点的文字内容进行分词, 分别得到包含多个 词的第一单词序列和第二单词序列; 判断所述第一单词序列是否具有与所述第二单词序列中的单词含义相同的词; 若存在, 则用所述含义相同的词替换所述第二单词序列中与所述含义相同的词对应的 词。 5.根据权利要求2所述的H5工程文件的说明文档生成方法, 其特征在于, 所述根据所述 第一注释内容对应的级别, 以所述第一注释内容作为多个级别节点, 生成具有层级结构的 第一说明文档的步骤之后, 包括: 在所述第一说明文档的级别节点上生成第一链接, 所述第一链接链。

8、接至所述第一H5工 程文件中与级别节点相对应的第一注释内容。 6.根据权利要求2所述的H5工程文件的说明文档生成方法, 其特征在于, 所述根据所述 第二注释内容对应的级别, 以所述第二注释内容作为多个级别节点, 生成具有层级结构的 第二说明文档的步骤之后, 包括: 在所述第二说明文档的级别节点上生成第二链接, 所述第二链接链接至所述第二H5工 程文件中与所述级别节点相对应的第二注释内容。 7.根据权利要求1所述的H5工程文件的说明文档生成方法, 其特征在于, 所述以所述第 一相似节点至第一说明文档的根节点的路径为第一枝干, 及以所述第二相似节点至第二说 明文档的根节点的路径为第二枝干, 生成具。

9、有树形结构的目标说明文档的步骤之后, 包括: 在所述第一枝干的第一相似节点上生成链接至所述第一H5工程文件中与所述第一相 似节点相对应注释内容的链接; 以及, 在所述第二枝干的第二相似节点上生成链接至所述第二H5工程文件中与所述第 二相似节点相对应注释内容的链接。 8.一种H5工程文件的说明文档生成装置, 其特征在于, 包括: 说明文档生成单元, 用于遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工 程文件和第二H5工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及第二说 明文档, 其中第一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指第二 H5工程文件的。

10、树形结构说明文档; 相似度计算单元, 用于采用相似度算法, 计算出所述第一说明文档的节点的文字内容 与所述第二说明文档的节点的文字内容的相似度; 预设阈值判断单元, 用于若所述相似度大于预设阈值, 则将对应的所述第一说明文档 的节点及所述第二说明文档的节点分别标记为第一相似节点及第二相似节点; 目标说明文档生成单元, 用于以所述第一相似节点至第一说明文档的根节点的路径为 第一枝干, 及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有 权利要求书 2/3 页 3 CN 110110293 A 3 树形结构的目标说明文档。 9.一种计算机设备, 包括存储器和处理器, 所述存储器。

11、存储有计算机程序, 其特征在 于, 所述处理器执行所述计算机程序时实现权利要求1至7中任一项所述方法的步骤。 10.一种计算机可读存储介质, 其上存储有计算机程序, 其特征在于, 所述计算机程序 被处理器执行时实现权利要求1至7中任一项所述的方法的步骤。 权利要求书 3/3 页 4 CN 110110293 A 4 H5工程文件的说明文档生成方法、 装置和计算机设备 技术领域 0001 本申请涉及到计算机领域, 特别是涉及到一种H5工程文件的说明文档生成方法、 装置、 计算机设备和存储介质。 背景技术 0002 代码工程文件中, 有一些代码实现相同或相似的功能。 虽然在代码工程文件中, 对 于。

12、部分代码可能会有注释说明, 便于代码开发人员检查工程文件中的代码。 但是这些注释 说明仅存在于相应的代码处, 难以与其他相类似的代码进行比较。 尤其在不同工程文件中, 实现相同或相似功能的代码可能有多种, 其中有优有劣, 代码开发人员若能对这些相同或 相似功能的代码进行查看比较, 必然能提高代码水平。 即, 现有技术中缺少将具有相同或相 似功能的代码的注释内容统一收集起来的技术方案。 发明内容 0003 本申请的主要目的为提供一种H5工程文件的说明文档生成方法、 装置、 计算机设 备和存储介质, 旨在生成具有将相同或相似功能的代码的注释内容统一收集起来的说明文 档。 0004 为了实现上述发明。

13、目的, 本申请提出一种H5工程文件的说明文档生成方法, 包括 以下步骤: 0005 遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工程文件和第二H5工程 文件中的注释内容, 并根据所述注释内容生成第一说明文档及第二说明文档, 其中第一说 明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指第二H5工程文件的树形结 构说明文档; 0006 采用相似度算法, 计算出所述第一说明文档的节点的文字内容与所述第二说明文 档的节点的文字内容的相似度; 0007 若所述相似度大于预设阈值, 则将对应的所述第一说明文档的节点及所述第二说 明文档的节点分别标记为第一相似节点及第二相似节点; 。

14、0008 以所述第一相似节点至第一说明文档的根节点的路径为第一枝干, 及以所述第二 相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形结构的目标说明文 档。 0009 进一步地, 所述遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工程文 件和第二H5工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及第二说明文 档, 其中第一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指第二H5工 程文件的树形结构说明文档的步骤, 包括: 0010 在所述第一H5工程文件中查询多个级别的注释标识符, 获取多个级别的第一注释 内容; 0011 根据所述第一注释内容。

15、对应的级别, 以所述第一注释内容作为多个级别节点, 生 说明书 1/13 页 5 CN 110110293 A 5 成具有层级结构的第一说明文档; 0012 以及, 在所述第二H5工程文件中查询多个级别的注释标识符, 获取多个级别的第 二注释内容; 0013 根据所述第二注释内容对应的级别, 以所述第二注释内容作为多个级别节点, 生 成具有层级结构的第二说明文档。 0014 进一步地, 所述采用相似度算法, 计算出所述第一说明文档的节点的文字内容与 所述第二说明文档的节点的文字内容的相似度的步骤包括: 0015 采用公式: 0016 0017 计算出所述第一说明文档与第二说明文档的节点的文字内。

16、容的相似度; 其中 similarity为相似度, A为所述第一说明文档的节点的文字内容的词频向量, B为所述第二 说明文档的节点的文字内容的词频向量, Ai为所述第一说明文档的节点的文字内容的第i 个单词出现的次数, Bi为所述第二说明文档的节点的文字内容的第i个单词出现的次数。 0018 进一步地, 所述采用公式: 0019 0020 计算出所述第一说明文档与第二说明文档的节点的文字内容的相似度的步骤之 前, 包括: 0021 对所述第一说明文档与第二说明文档的节点的文字内容进行分词, 分别得到包含 多个词的第一单词序列和第二单词序列; 0022 判断所述第一单词序列是否具有与所述第二单词。

17、序列中的单词含义相同的词; 0023 若存在, 则用所述含义相同的词替换所述第二单词序列中与所述含义相同的词对 应的词。 0024 进一步地, 所述根据所述第一注释内容对应的级别, 以所述第一注释内容作为多 个级别节点, 生成具有层级结构的第一说明文档的步骤之后, 包括: 0025 在所述第一说明文档的级别节点上生成第一链接, 所述第一链接链接至所述第一 H5工程文件中与级别节点相对应的第一注释内容。 0026 进一步地, 所述根据所述第二注释内容对应的级别, 以所述第二注释内容作为多 个级别节点, 生成具有层级结构的第二说明文档的步骤之后, 包括: 0027 在所述第二说明文档的级别节点上生。

18、成第二链接, 所述第二链接链接至所述第二 H5工程文件中与所述级别节点相对应的第二注释内容。 0028 进一步地, 以所述第一相似节点至第一说明文档的根节点的路径为第一枝干, 及 以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形结构的目 标说明文档的步骤之后, 包括: 说明书 2/13 页 6 CN 110110293 A 6 0029 在所述第一枝干的第一相似节点上生成链接至所述第一H5工程文件中与所述第 一相似节点相对应注释内容的链接; 0030 以及, 在所述第二枝干的第二相似节点上生成链接至所述第二H5工程文件中与所 述第二相似节点相对应注释内容的链接。 003。

19、1 本申请提供一种H5工程文件的说明文档生成装置, 包括: 0032 说明文档生成单元, 用于遍历第一H5工程文件和第二H5工程文件, 提取所述第一 H5工程文件和第二H5工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及第 二说明文档, 其中第一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指 第二H5工程文件的树形结构说明文档; 0033 相似度计算单元, 用于采用相似度算法, 计算出所述第一说明文档的节点的文字 内容与所述第二说明文档的节点的文字内容的相似度; 0034 预设阈值判断单元, 用于若所述相似度大于预设阈值, 则将对应的所述第一说明 文档的节点及所述第。

20、二说明文档的节点分别标记为第一相似节点及第二相似节点; 0035 目标说明文档生成单元, 用于以所述第一相似节点至第一说明文档的根节点的路 径为第一枝干, 及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成 具有树形结构的目标说明文档。 0036 本申请提供一种计算机设备, 包括存储器和处理器, 所述存储器存储有计算机程 序, 所述处理器执行所述计算机程序时实现上述任一项所述方法的步骤。 0037 本申请提供一种计算机可读存储介质, 其上存储有计算机程序, 所述计算机程序 被处理器执行时实现上述任一项所述的方法的步骤。 0038 本申请的H5工程文件的说明文档生成方法、 装置、。

21、 计算机设备和存储介质, 通过遍 历H5工程文件, 生成两个说明文档, 采用相似度算法计算出两个说明文档的节点文字的相 似度, 将相似度高的节点至根节点的路径作为目标说明文档的枝干, 从成生成目标说明文 档, 有助于代码优化、 提高代码开发人员的代码水平。 附图说明 0039 图1为本申请一实施例的H5工程文件的说明文档生成方法的流程示意图; 0040 图2为本申请一实施例的H5工程文件的说明文档生成装置的结构示意框图; 0041 图3为本申请一实施例的计算机设备的结构示意框图。 0042 本申请目的的实现、 功能特点及优点将结合实施例, 参照附图做进一步说明。 具体实施方式 0043 为了使。

22、本申请的目的、 技术方案及优点更加清楚明白, 以下结合附图及实施例, 对 本申请进行进一步详细说明。 应当理解, 此处描述的具体实施例仅仅用以解释本申请, 并不 用于限定本申请。 0044 参照图1, 本申请实施例提供一种H5工程文件的说明文档生成方法, 包括以下步 骤: 0045 S1、 遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工程文件和第二H5 工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及第二说明文档, 其中第 说明书 3/13 页 7 CN 110110293 A 7 一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指第二H5工程文件的树 。

23、形结构说明文档; 0046 S2、 采用相似度算法, 计算出所述第一说明文档的节点的文字内容与所述第二说 明文档的节点的文字内容的相似度; 0047 S3、 若所述相似度大于预设阈值, 则将对应的所述第一说明文档的节点及所述第 二说明文档的节点分别标记为第一相似节点及第二相似节点; 0048 S4、 以所述第一相似节点至第一说明文档的根节点的路径为第一枝干, 及以所述 第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形结构的目标说明 文档。 0049 如上述步骤S1所述, 遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工 程文件和第二H5工程文件中的注释内容, 并根。

24、据所述注释内容生成第一说明文档及第二说 明文档, 其中第一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指第二 H5工程文件的树形结构说明文档。 其中H5工程文件是指html5工程代码文件, 用于生成前端 可视化html5页面以及前端逻辑处理的工程文件。 说明文档是指对H5工程文件的代码进行 注释说明的文档。 H5工程文件中包括有对代码进行注释说明的文字内容, 通过遍历H5工程 文件将所述文字内容提取出来以树形结构展示, 即形成了说明文档。 从而获取第一说明文 档及第二说明文档。 其中注释内容包括: 对代码的功能进行注释的内容。 0050 如上述步骤S2所述, 采用相似度算法, 。

25、计算出所述第一说明文档的节点的文字内 容与所述第二说明文档的节点的文字内容的相似度。 若第一说明文档的节点的文字内容 (即对代码的注释内容)与第二说明文档的节点的文字内容相同或相似, 表明这两个节点对 应的代码的功能相同。 其中相似度算法包括: 重叠词相似度算法; 基于词向量的向量距离算 法。 0051 如上述步骤S3所述, 若所述相似度大于预设阈值, 则将对应的所述第一说明文档 的节点及所述第二说明文档的节点分别标记为第一相似节点及第二相似节点。 若相似度大 于预设阈值, 表明所述第一说明文档的节点与第二说明文档的节点的注释内容相同或相 似, 从而判断相应的代码功能相同或相似。 其中所述预设。

26、阈值例如为80-98中的任一 数值。 0052 如上述步骤S4所述, 以所述第一相似节点至第一说明文档的根节点的路径为第一 枝干, 及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形 结构的目标说明文档。 据此, 新生成的目标说明文档包括了以相似节点为终点的两条路径, 通过查阅这两条路径的内容及相应的代码, 再进行比较, 即可得知谁优谁劣, 有助于代码水 平提高。 其中当第一相似节点有多个时, 第一枝干相应的也有多个; 同理, 当第二相似节点 有多个时, 第二枝干相应的也有多个。 0053 在一个实施方式中, 所述遍历第一H5工程文件和第二H5工程文件, 提取所述第一 。

27、H5工程文件和第二H5工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及第 二说明文档, 其中第一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档指 第二H5工程文件的树形结构说明文档的步骤S1, 包括: 0054 S101、 在所述第一H5工程文件中查询多个级别的注释标识符, 获取多个级别的第 一注释内容; 说明书 4/13 页 8 CN 110110293 A 8 0055 S102、 根据所述第一注释内容对应的级别, 以所述第一注释内容作为多个级别节 点, 生成具有层级结构的第一说明文档; 0056 S103、 以及, 在所述第二H5工程文件中查询多个级别的注释标识。

28、符, 获取多个级别 的第二注释内容; 0057 S104、 根据所述第二注释内容对应的级别, 以所述第二注释内容作为多个级别节 点, 生成具有层级结构的第二说明文档。 0058 如上所述, 实现了获取第一说明文档及第二说明文档。 其中注释标识符包括: “/” 、“” 、“#” 等。 其中注释内容之前与之后, 均有相同的注释标识, 从而将注释内容 与代码内容分隔开来, 据此也可将注释内容提取出来。 从而提取出不同级别的注释内容, 再 将注释内容以层级结构的形式在说明文档中展现出来, 最终获得了具有层级结构的第一说 明文档和第二说明文档。 其中, 根据所述第一注释内容对应的级别, 以所述第一注释内。

29、容作 为多个级别节点, 生成具有层级结构的第一说明文档, 表明: 级别节点在所述第一说明文档 中的级别和第一注释内容在第一H5工程文件中的级别相同。 同理, 级别节点在所述第二说 明文档中的级别和第二注释内容在第二H5工程文件中的级别相同。 0059 在一个实施方式中, 所述采用相似度算法, 计算出所述第一说明文档的节点的文 字内容与所述第二说明文档的节点的文字内容的相似度的步骤S2, 包括: 0060 S201、 采用公式: 0061 0062 计算出所述第一说明文档与第二说明文档的节点的文字内容的相似度; 其中 similarity为相似度, A为所述第一说明文档的节点的文字内容的词频向量。

30、, B为所述第二 说明文档的节点的文字内容的词频向量, Ai为所述第一说明文档的节点的文字内容的第i 个单词出现的次数, Bi为所述第二说明文档的节点的文字内容的第i个单词出现的次数。 0063 如上所述, 实现了计算出所述第一说明文档与第二说明文档的节点的文字内容的 相似度。 所述词频向量是以文字内容中的各词出现的次数(频率)作为向量的维度数值, 所 构成的多维向量。 即A(A1,A2,An),其中An为最后一个词(共有n个词)的词频。 所述相 似度算法是根据两个节点的文字内容的余弦相似度进行计算得到, 以反应两个节点的文字 内容间的相似程度。 当similarity的值越接近于1, 表明越。

31、相似; 越接近于0, 表明越不相似。 0064 在一个实施方式中, 所述采用公式: 0065 0066 计算出所述第一说明文档与第二说明文档的节点的文字内容的相似度的步骤 S201之前, 包括: 0067 S2001、 对所述第一说明文档与第二说明文档的节点的文字内容进行分词, 分别得 到包含多个词的第一单词序列和第二单词序列; 说明书 5/13 页 9 CN 110110293 A 9 0068 S2002、 判断所述第一单词序列是否具有与所述第二单词序列中的单词含义相同 的词; 0069 S2003、 若存在, 则用所述含义相同的词替换所述第二单词序列中与所述含义相同 的词对应的词。 00。

32、70 如上所述, 实现了对文字内容进行预处理。 其中分词可使用开源的分词工具, 例如 jieba、 SnowNLP、 THULAC、 NLPIR。 分词方法包括: 基于字符串匹配的分词方法、 基于理解的分 词方法和基于统计的分词方法。 从而将单个单句分为多个词。 为了增加相似度判断的准确 性, 判断所述第一单词序列是否具有与所述第二单词序列中的单词含义相同的词, 若存在, 若存在, 则将所述同义词替换所述第二单词序列中与所述同义词对应的词。 一般而言, 同义 词的替换并不会导致单句的原义发生改变, 而且能够避免将同义的词由于撰写的小区别而 造成相似度的错判。 0071 在一个实施方式中, 所述。

33、根据所述第一注释内容对应的级别, 以所述第一注释内 容作为多个级别节点, 生成具有层级结构的第一说明文档的步骤S102之后, 包括: 0072 S1021、 在所述第一说明文档的级别节点上生成第一链接, 所述第一链接链接至所 述第一H5工程文件中与级别节点相对应的第一注释内容。 0073 如上所述, 实现了在所述级别节点上生成第一链接。 据此, 当需要查阅相应的注释 内容与代码时, 可以通过第一链接直接转到第一H5工程文件中与所述级别节点相对应的第 一注释内容处(因为第一注释内容与其相应代码位于第一H5工程文件中的相同位置)。 对应 的, 第一H5工程文件中与所述级别节点相对应的第一注释内容也。

34、可以设置有对应链接至第 一说明文档中级别节点位置的链接。 0074 在一个实施方式中, 所述根据所述第二注释内容对应的级别, 以所述第二注释内 容作为多个级别节点, 生成具有层级结构的第二说明文档的步骤S104之后, 包括: 0075 S1041、 在所述第二说明文档的级别节点上生成第二链接, 所述第二链接链接至所 述第二H5工程文件中与所述级别节点相对应的第二注释内容。 0076 如上所述, 实现了在所述级别节点上生成第二链接。 据此, 当需要查阅相应的注释 内容与代码时, 可以通过第二链接直接转到第二H5工程文件中与所述级别节点相对应的第 二注释内容处(因为第二注释内容与其相应代码位于第二。

35、H5工程文件中的相同位置)。 对应 的, 第二H5工程文件中与所述级别节点相对应的第二注释内容也可以设置有对应链接至第 二说明文档中级别节点位置的链接。 0077 在一个实施方式中, 以所述第一相似节点至第一说明文档的根节点的路径为第一 枝干, 及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形 结构的目标说明文档的步骤S4之后, 包括: 0078 S5、 在所述第一枝干的第一相似节点上生成链接至所述第一H5工程文件中与所述 第一相似节点相对应注释内容的链接; 0079 S6、 以及, 在所述第二枝干的第二相似节点上生成链接至所述第二H5工程文件中 与所述第二相似节点相。

36、对应注释内容的链接。 0080 如上所述, 实现了在第一枝干的第一相似节点上生成链接, 以及在所述第二枝干 的第二相似节点上生成链接。 从而, 当需要查阅相应注释内容与代码时, 可以通过相应链接 转至第一H5工程文件中或者第二H5工程文件中的相应位置。 从而可以比较实现相同功能的 说明书 6/13 页 10 CN 110110293 A 10 代码之间的差别, 进而优化代码结构, 提高水平。 0081 本申请的H5工程文件的说明文档生成方法, 通过遍历H5工程文件, 生成两个说明 文档, 采用相似度算法计算出两个说明文档的节点文字的相似度, 将相似度高的节点至根 节点的路径作为目标说明文档的枝。

37、干, 从成生成目标说明文档, 有助于代码优化、 提高代码 开发人员的代码水平。 0082 参照图2, 本申请实施例提供一种H5工程文件的说明文档生成装置, 包括: 0083 说明文档生成单元10, 用于遍历第一H5工程文件和第二H5工程文件, 提取所述第 一H5工程文件和第二H5工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及 第二说明文档, 其中第一说明文档指第一H5工程文件的树形结构说明文档, 第二说明文档 指第二H5工程文件的树形结构说明文档; 0084 相似度计算单元20, 用于采用相似度算法, 计算出所述第一说明文档的节点的文 字内容与所述第二说明文档的节点的文字内容的相。

38、似度; 0085 预设阈值判断单元30, 用于若所述相似度大于预设阈值, 则将对应的所述第一说 明文档的节点及所述第二说明文档的节点分别标记为第一相似节点及第二相似节点; 0086 目标说明文档生成单元40, 用于以所述第一相似节点至第一说明文档的根节点的 路径为第一枝干, 及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生 成具有树形结构的目标说明文档。 0087 如上述单元10所述, 遍历第一H5工程文件和第二H5工程文件, 提取所述第一H5工 程文件和第二H5工程文件中的注释内容, 并根据所述注释内容生成第一说明文档及第二说 明文档, 其中第一说明文档指第一H5工程文件的树。

39、形结构说明文档, 第二说明文档指第二 H5工程文件的树形结构说明文档。 其中H5工程文件是指html5工程代码文件, 用于生成前端 可视化html5页面以及前端逻辑处理的工程文件。 说明文档是指对H5工程文件的代码进行 注释说明的文档。 H5工程文件中包括有对代码进行注释说明的文字内容, 通过遍历H5工程 文件将所述文字内容提取出来以树形结构展示, 即形成了说明文档。 从而获取第一说明文 档及第二说明文档。 其中注释内容包括: 对代码的功能进行注释的内容。 0088 如上述单元20所述, 采用相似度算法, 计算出所述第一说明文档的节点的文字内 容与所述第二说明文档的节点的文字内容的相似度。 若。

40、第一说明文档的节点的文字内容 (即对代码的注释内容)与第二说明文档的节点的文字内容相同或相似, 表明这两个节点对 应的代码的功能相同。 其中相似度算法包括: 重叠词相似度算法; 基于词向量的向量距离算 法。 0089 如上述单元30所述, 若所述相似度大于预设阈值, 则将对应的所述第一说明文档 的节点及所述第二说明文档的节点分别标记为第一相似节点及第二相似节点。 若相似度大 于预设阈值, 表明所述第一说明文档的节点与第二说明文档的节点的注释内容相同或相 似, 从而判断相应的代码功能相同或相似。 其中所述预设阈值例如为80-98中的任一 数值。 0090 如上述单元40所述, 以所述第一相似节点。

41、至第一说明文档的根节点的路径为第一 枝干, 及以所述第二相似节点至第二说明文档的根节点的路径为第二枝干, 生成具有树形 结构的目标说明文档。 据此, 新生成的目标说明文档包括了以相似节点为终点的两条路径, 通过查阅这两条路径的内容及相应的代码, 再进行比较, 即可得知谁优谁劣, 有助于代码水 说明书 7/13 页 11 CN 110110293 A 11 平提高。 其中当第一相似节点有多个时, 第一枝干相应的也有多个; 同理, 当第二相似节点 有多个时, 第二枝干相应的也有多个。 0091 在一个实施方式中, 所述说明文档生成单元10, 包括: 0092 第一注释内容获取子单元, 用于在所述第。

42、一H5工程文件中查询多个级别的注释标 识符, 获取多个级别的第一注释内容; 0093 第一说明文档获取子单元, 用于根据所述第一注释内容对应的级别, 以所述第一 注释内容作为多个级别节点, 生成具有层级结构的第一说明文档; 0094 第二注释内容获取子单元, 用于以及, 在所述第二H5工程文件中查询多个级别的 注释标识符, 获取多个级别的第二注释内容; 0095 第二说明文档获取子单元, 用于根据所述第二注释内容对应的级别, 以所述第二 注释内容作为多个级别节点, 生成具有层级结构的第二说明文档。 0096 如上所述, 实现了获取第一说明文档及第二说明文档。 其中注释标识符包括: “/” 、“。

43、” 、“#” 等。 其中注释内容之前与之后, 均有相同的注释标识, 从而将注释内容 与代码内容分隔开来, 据此也可将注释内容提取出来。 从而提取出不同级别的注释内容, 再 将注释内容以层级结构的形式在说明文档中展现出来, 最终获得了具有层级结构的第一说 明文档和第二说明文档。 其中, 根据所述第一注释内容对应的级别, 以所述第一注释内容作 为多个级别节点, 生成具有层级结构的第一说明文档, 表明: 级别节点在所述第一说明文档 中的级别和第一注释内容在第一H5工程文件中的级别相同。 同理, 级别节点在所述第二说 明文档中的级别和第二注释内容在第二H5工程文件中的级别相同。 0097 在一个实施方。

44、式中, 所述相似度计算单元20, 包括: 0098 相似度计算子单元,用于采用公式: 0099 0100 计算出所述第一说明文档与第二说明文档的节点的文字内容的相似度; 其中 similarity为相似度, A为所述第一说明文档的节点的文字内容的词频向量, B为所述第二 说明文档的节点的文字内容的词频向量, Ai为所述第一说明文档的节点的文字内容的第i 个单词出现的次数, Bi为所述第二说明文档的节点的文字内容的第i个单词出现的次数。 0101 如上所述, 实现了计算出所述第一说明文档与第二说明文档的节点的文字内容的 相似度。 所述词频向量是以文字内容中的各词出现的次数(频率)作为向量的维度数。

45、值, 所 构成的多维向量。 即A(A1,A2,An),其中An为最后一个词(共有n个词)的词频。 所述相 似度算法是根据两个节点的文字内容的余弦相似度进行计算得到, 以反应两个节点的文字 内容间的相似程度。 当similarity的值越接近于1, 表明越相似; 越接近于0, 表明越不相似。 0102 在一个实施方式中, 所述相似度计算单元20, 包括: 0103 单词序列获取子单元, 用于对所述第一说明文档与第二说明文档的节点的文字内 容进行分词, 分别得到包含多个词的第一单词序列和第二单词序列; 0104 含义相同的词判断子单元, 用于判断所述第一单词序列是否具有与所述第二单词 序列中的单词。

46、含义相同的词; 说明书 8/13 页 12 CN 110110293 A 12 0105 替换子单元, 用于若存在, 则用所述含义相同的词替换所述第二单词序列中与所 述含义相同的词对应的词。 0106 如上所述, 实现了对文字内容进行预处理。 其中分词可使用开源的分词工具, 例如 jieba、 SnowNLP、 THULAC、 NLPIR。 分词方法包括: 基于字符串匹配的分词方法、 基于理解的分 词方法和基于统计的分词方法。 从而将单个单句分为多个词。 为了增加相似度判断的准确 性, 判断所述第一单词序列是否具有与所述第二单词序列中的单词含义相同的词, 若存在, 若存在, 则将所述同义词替换。

47、所述第二单词序列中与所述同义词对应的词。 一般而言, 同义 词的替换并不会导致单句的原义发生改变, 而且能够避免将同义的词由于撰写的小区别而 造成相似度的错判。 0107 在一个实施方式中, 所述装置, 包括: 0108 第一链接生成单元, 用于在所述第一说明文档的级别节点上生成第一链接, 所述 第一链接链接至所述第一H5工程文件中与级别节点相对应的第一注释内容。 0109 如上所述, 实现了在所述级别节点上生成第一链接。 据此, 当需要查阅相应的注释 内容与代码时, 可以通过第一链接直接转到第一H5工程文件中与所述级别节点相对应的第 一注释内容处(因为第一注释内容与其相应代码位于第一H5工程。

48、文件中的相同位置)。 对应 的, 第一H5工程文件中与所述级别节点相对应的第一注释内容也可以设置有对应链接至第 一说明文档中级别节点位置的链接。 0110 在一个实施方式中, 所述装置, 包括: 0111 第二链接生成单元, 用于在所述第二说明文档的级别节点上生成第二链接, 所述 第二链接链接至所述第二H5工程文件中与所述级别节点相对应的第二注释内容。 0112 如上所述, 实现了在所述级别节点上生成第二链接。 据此, 当需要查阅相应的注释 内容与代码时, 可以通过第二链接直接转到第二H5工程文件中与所述级别节点相对应的第 二注释内容处(因为第二注释内容与其相应代码位于第二H5工程文件中的相同。

49、位置)。 对应 的, 第二H5工程文件中与所述级别节点相对应的第二注释内容也可以设置有对应链接至第 二说明文档中级别节点位置的链接。 0113 在一个实施方式中, 所述装置, 包括: 0114 第一枝干链接生成单元, 用于在所述第一枝干的第一相似节点上生成链接至所述 第一H5工程文件中与所述第一相似节点相对应注释内容的链接; 0115 第二枝干链接生成单元, 用于以及, 在所述第二枝干的第二相似节点上生成链接 至所述第二H5工程文件中与所述第二相似节点相对应注释内容的链接。 0116 如上所述, 实现了在第一枝干的第一相似节点上生成链接, 以及在所述第二枝干 的第二相似节点上生成链接。 从而,。

50、 当需要查阅相应注释内容与代码时, 可以通过相应链接 转至第一H5工程文件中或者第二H5工程文件中的相应位置。 从而可以比较实现相同功能的 代码之间的差别, 进而优化代码结构, 提高水平。 0117 本申请的H5工程文件的说明文档生成装置, 通过遍历H5工程文件, 生成两个说明 文档, 采用相似度算法计算出两个说明文档的节点文字的相似度, 将相似度高的节点至根 节点的路径作为目标说明文档的枝干, 从成生成目标说明文档, 有助于代码优化、 提高代码 开发人员的代码水平。 0118 参照图3, 本发明实施例中还提供一种计算机设备, 该计算机设备可以是服务器, 说明书 9/13 页 13 CN 11。

展开阅读全文
内容关键字: H5 工程 文件 说明 文档 生成 方法 装置 计算机 设备
关于本文
本文标题:H5工程文件的说明文档生成方法、装置和计算机设备.pdf
链接地址:https://www.zhuanlichaxun.net/pdf/11457416.html
关于我们 - 网站声明 - 网站地图 - 资源地图 - 友情链接 - 网站客服 - 联系我们

copyright@ 2017-2018 zhuanlichaxun.net网站版权所有
经营许可证编号:粤ICP备2021068784号-1 
 


收起
展开