一种应用组件的说明文档生成方法和装置制造方法及图纸

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

【技术实现步骤摘要】
一种应用组件的说明文档生成方法和装置
本专利技术涉及计算机
，尤其涉及一种应用组件的说明文档生成方法和装置。
技术介绍
基于Javascript(一种基于新的ES6标准使它成为前后端都可使用的语言)为核心的架构从Grunt(一个基于任务的JavaScript工程命令行构建工具)、Gulp(一种基于流的，代码优于配置的新一代构建工具)到Webpack(基于NodeJs的一种Javascript架构，负责图片、文件和脚本等内容的编译打包)，每一个架构都提供了更先进和更好的编译打包方式。从开发角度，组件设计完成后通常花费相当长的时间去润色谱写精致的文档，以方便使用者进行更好的体验。除了需要花费过多的时间去写文档用例、API(应用程序接口)和润色文档的介绍，在谱写的过程中还会遗忘设计师当初的精妙绝伦的想法，此外，一份文档要经过很长时间才会完成，而说明文档在完成之后才能被使用，这样的速度无疑不能满足新技术的发布需求。从开发者角度来说，软件应用规范的设计流程从需求、概要、详细、编码、测试、撰写文档说明并交付验收。从编码开始到撰写文档，在完成编码和测试环节后，再去编写对应的软件使用文档说明，这个过程耗时长而且写的内容常常会有疏漏。通常写文档都会比编码和测试的速度慢很多，因此这个周期会耗费大量的人力物力。在实现本专利技术过程中，专利技术人发现现有技术中至少存在如下问题：耗时长，设计者需要从头到尾进行回想撰写文档；文档谱写浪费过多的人力物力；内容不细致，文档后置撰写的问题就是遗忘了先前的设计想法；用例引入到文档中后，如果编码变更还要进行调整和修改；文档格式不统一，且文档用例需要另外设计。
技术实现思路
有鉴于此，本专利技术实施例提供一种应用组件的说明文档生成方法和装置，能够代替人工处理方式，节省了大量的时间和人力物力，避免文档后置撰写而遗忘了先前的设计想法，并避免编码变更还要进行调整和修改生成的文档的问题，且生成的说明文档更具有规格统一性，适合大范围使用和成批生成，生成过程相对简单。为实现上述目的，根据本专利技术实施例的一个方面，提供了一种应用组件的说明文档生成方法。一种应用组件的说明文档生成方法，包括：从获取的预设格式的应用组件文件流中提取样式信息和脚本信息；根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流；通过预设的文本解析器解析所述预设格式的应用组件文件流以得到说明文本文件流；根据所述用例文件流和所述说明文本文件流生成所述应用组件的说明文档。可选地，从获取的预设格式的应用组件文件流中提取样式信息和脚本信息的步骤之前，包括：判断缓存中是否存在所述预设格式的应用组件文件流，若存在，则从所述缓存中获取所述预设格式的应用组件文件流，否则，缓存输入的所述预设格式的应用组件文件流，然后获取缓存中的所述预设格式的应用组件文件流。可选地，从获取的预设格式的应用组件文件流中提取样式信息和脚本信息的步骤，包括：从获取的预设格式的应用组件文件流中，提取以Div为父标签、且带有HTML标记的内容块作为所述样式信息，以及提取带有JS标记的内容块作为所述脚本信息。可选地，所述应用组件为Avalon应用组件，所述预设模板为Avalon标准组件对象模板，根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流的步骤，包括：将所述脚本信息转换成HTML形式脚本信息，并将所述样式信息与所述HTML形式脚本信息按照所述Avalon标准组件对象模板的格式进行拼接，以生成所述应用组件的用例文件流。可选地，根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流的步骤之后，包括：确定所述用例文件流通过预设校验。根据本专利技术实施例的另一方面，提供了一种应用组件的说明文档生成装置。一种应用组件的说明文档生成装置，包括：信息提取模块，用于从获取的预设格式的应用组件文件流中提取样式信息和脚本信息；第一文件流生成模块，用于根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流；第二文件流生成模块，用于通过预设的文本解析器解析所述预设格式的应用组件文件流以得到说明文本文件流；说明文档生成模块，用于根据所述用例文件流和所述说明文本文件流生成所述应用组件的说明文档。可选地，还包括判断模块，用于：判断缓存中是否存在所述预设格式的应用组件文件流，若存在，则从所述缓存中获取所述预设格式的应用组件文件流，否则，缓存输入的所述预设格式的应用组件文件流，然后获取缓存中的所述预设格式的应用组件文件流。可选地，所述信息提取模块还用于：从获取的预设格式的应用组件文件流中，提取以Div为父标签、且带有HTML标记的内容块作为所述样式信息，以及提取带有JS标记的内容块作为所述脚本信息。可选地，所述应用组件为Avalon应用组件，所述预设模板为Avalon标准组件对象模板，所述第一文件流生成模块还用于：将所述脚本信息转换成HTML形式脚本信息，并将所述样式信息与所述HTML形式脚本信息按照所述Avalon标准组件对象模板的格式进行拼接，以生成所述应用组件的用例文件流。可选地，还包括确定模块，用于：确定所述用例文件流通过预设校验。根据本专利技术实施例的又一方面，提供了一种电子设备。一种电子设备，包括：一个或多个处理器；存储器，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现应用组件的说明文档生成方法。根据本专利技术实施例的又一方面，提供了一种计算机可读介质。一种计算机可读介质，其上存储有计算机程序，其特征在于，所述程序被处理器执行时实现应用组件的说明文档生成方法。上述专利技术中的一个实施例具有如下优点或有益效果：从获取的预设格式的应用组件文件流中提取样式信息和脚本信息，并根据样式信息和脚本信息，通过预设模板生成应用组件的用例文件流，以及通过预设的文本解析器解析预设格式的应用组件文件流以得到说明文本文件流，然后根据用例文件流和说明文本文件流生成应用组件的说明文档。能够在开发中的撰写文档部分以工具化代替人工处理方式，根据要求自动化转换文件完成文字说明、展示用例、代码说明和接口列表说明等内容，节省了大量的时间和人力物力，且能够在一个文件中写组件用例时也能写组件的使用说明而不用将二者分开撰写，避免文档后置撰写而遗忘了先前的设计想法，生成的说明文档更具有规格统一性，适合大范围使用和成批生成，且生成过程相对简单。上述的非惯用的可选方式所具有的进一步效果将在下文中结合具体实施方式加以说明。附图说明附图用于更好地理解本专利技术，不构成对本专利技术的不当限定。其中：图1是根据本专利技术实施例的应用组件的说明文档生成方法的主要步骤示意图；图2是根据本专利技术实施例的应用组件的说明文档生成方法的优选流程示意图；图3是根据本专利技术实施例的应用组件的说明文档生成装置的主要模块示意图；图4是适于用来实现本专利技术实施例的终端设备或服务器的计算机系统的结构示意图。具体实施方式以下结合附图对本专利技术的示范性实施例做出说明，其中包括本专利技术实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本专利技术的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知本文档来自技高网...

【技术保护点】
1.一种应用组件的说明文档生成方法，其特征在于，包括：从获取的预设格式的应用组件文件流中提取样式信息和脚本信息；根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流；通过预设的文本解析器解析所述预设格式的应用组件文件流以得到说明文本文件流；根据所述用例文件流和所述说明文本文件流生成所述应用组件的说明文档。

【技术特征摘要】
1.一种应用组件的说明文档生成方法，其特征在于，包括：从获取的预设格式的应用组件文件流中提取样式信息和脚本信息；根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流；通过预设的文本解析器解析所述预设格式的应用组件文件流以得到说明文本文件流；根据所述用例文件流和所述说明文本文件流生成所述应用组件的说明文档。2.根据权利要求1所述的方法，其特征在于，从获取的预设格式的应用组件文件流中提取样式信息和脚本信息的步骤之前，包括：判断缓存中是否存在所述预设格式的应用组件文件流，若存在，则从所述缓存中获取所述预设格式的应用组件文件流，否则，缓存输入的所述预设格式的应用组件文件流，然后获取缓存中的所述预设格式的应用组件文件流。3.根据权利要求1所述的方法，其特征在于，从获取的预设格式的应用组件文件流中提取样式信息和脚本信息的步骤，包括：从获取的预设格式的应用组件文件流中，提取以Div为父标签、且带有HTML标记的内容块作为所述样式信息，以及提取带有JS标记的内容块作为所述脚本信息。4.根据权利要求1所述的方法，其特征在于，所述应用组件为Avalon应用组件，所述预设模板为Avalon标准组件对象模板，根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流的步骤，包括：将所述脚本信息转换成HTML形式脚本信息，并将所述样式信息与所述HTML形式脚本信息按照所述Avalon标准组件对象模板的格式进行拼接，以生成所述应用组件的用例文件流。5.根据权利要求1所述的方法，其特征在于，根据所述样式信息和所述脚本信息，通过预设模板生成所述应用组件的用例文件流的步骤之后，包括：确定所述用例文件流通过预设校验。6.一种应用组件的说明文档生成装置，其特征在于，包括：信息提取模块，用于从获取的预设格式的应用...

【专利技术属性】
技术研发人员：白玉洁，
申请(专利权)人：北京京东尚科信息技术有限公司，北京京东世纪贸易有限公司，
类型：发明
国别省市：北京,11