[发明专利]一种应用组件的说明文档生成方法和装置

说明书

本发明公开了一种应用组件的说明文档生成方法和装置，涉及计算机技术领域。该方法的一具体实施方式包括：从获取的预设格式的应用组件文件流中提取样式信息和脚本信息；根据样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流；通过预设的文本解析器解析所述预设格式的应用组件文件流以得到说明文本文件流；根据所述用例文件流和所述说明文本文件流生成所述应用组件的说明文档。该实施方式能够代替人工处理方式，节省了大量的时间和人力物力，避免文档后置撰写而遗忘了先前的设计想法，并避免编码变更还要进行调整和修改生成的文档的问题，且生成的说明文档更具有规格统一性，适合大范围使用和成批生成，生成过程相对简单。

技术领域

本发明涉及计算机技术领域，尤其涉及一种应用组件的说明文档生成方法和装置。

背景技术

基于Javascript(一种基于新的ES6标准使它成为前后端都可使用的语言)为核心的架构从Grunt(一个基于任务的JavaScript工程命令行构建工具)、Gulp(一种基于流的，代码优于配置的新一代构建工具)到Webpack(基于NodeJs的一种Javascript架构，负责图片、文件和脚本等内容的编译打包)，每一个架构都提供了更先进和更好的编译打包方式。从开发角度，组件设计完成后通常花费相当长的时间去润色谱写精致的文档，以方便使用者进行更好的体验。除了需要花费过多的时间去写文档用例、API(应用程序接口)和润色文档的介绍，在谱写的过程中还会遗忘设计师当初的精妙绝伦的想法，此外，一份文档要经过很长时间才会完成，而说明文档在完成之后才能被使用，这样的速度无疑不能满足新技术的发布需求。

从开发者角度来说，软件应用规范的设计流程从需求、概要、详细、编码、测试、撰写文档说明并交付验收。从编码开始到撰写文档，在完成编码和测试环节后，再去编写对应的软件使用文档说明，这个过程耗时长而且写的内容常常会有疏漏。通常写文档都会比编码和测试的速度慢很多，因此这个周期会耗费大量的人力物力。

在实现本发明过程中，发明人发现现有技术中至少存在如下问题：

耗时长，设计者需要从头到尾进行回想撰写文档；

文档谱写浪费过多的人力物力；

内容不细致，文档后置撰写的问题就是遗忘了先前的设计想法；

用例引入到文档中后，如果编码变更还要进行调整和修改；

文档格式不统一，且文档用例需要另外设计。

发明内容

有鉴于此，本发明实施例提供一种应用组件的说明文档生成方法和装置，能够代替人工处理方式，节省了大量的时间和人力物力，避免文档后置撰写而遗忘了先前的设计想法，并避免编码变更还要进行调整和修改生成的文档的问题，且生成的说明文档更具有规格统一性，适合大范围使用和成批生成，生成过程相对简单。

为实现上述目的，根据本发明实施例的一个方面，提供了一种应用组件的说明文档生成方法。

一种应用组件的说明文档生成方法，包括：从获取的预设格式的应用组件文件流中提取样式信息和脚本信息；根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流；通过预设的文本解析器解析所述预设格式的应用组件文件流以得到说明文本文件流；根据所述用例文件流和所述说明文本文件流生成所述应用组件的说明文档。

可选地，从获取的预设格式的应用组件文件流中提取样式信息和脚本信息的步骤之前，包括：判断缓存中是否存在所述预设格式的应用组件文件流，若存在，则从所述缓存中获取所述预设格式的应用组件文件流，否则，缓存输入的所述预设格式的应用组件文件流，然后获取缓存中的所述预设格式的应用组件文件流。

可选地，从获取的预设格式的应用组件文件流中提取样式信息和脚本信息的步骤，包括：从获取的预设格式的应用组件文件流中，提取以Div为父标签、且带有HTML标记的内容块作为所述样式信息，以及提取带有JS标记的内容块作为所述脚本信息。