[发明专利]一种用JavaFX进行代码样例自动填充的方法和工具

说明书

本发明属于代码技术领域，具体涉及一种用JavaFX进行代码样例自动填充的方法和工具，方法包括以下步骤：访问不同的统一资源标识符，并且定位HTML文档中的元素，再爬取定位到元素中的文本内容，获取问题信息和应用程序接口信息；通过爬虫访问问题详细信息页面，提取使用场景，建立应用程序接口类型、使用场景和代码样例的映射，并将原始数据加工为符合文档要求的数据；使用程序操作文档对象，通过代码逻辑预定义好文档模板和数据的组合形式，最后取出存储的数据嵌入文档，并保存生成最终的应用程序接口文档。

技术领域

本发明属于代码技术领域，具体涉及一种用JavaFX进行代码样例自动填充的方法和工具。

背景技术

阅读API文档一直是开发人员学习API的重要途径之一，通过API文档我们能最直观的了解到一个API最标准的和最直观的函数、类、返回类型、参数以及相应的作用。但是很多的API文档中只有API本身的定义，据研究表明，在Java SE和Android的API文档中，仅分别有11％和6％的API类型有代码样例加以补充说明，但是只附有模糊的使用场景。大量的API缺少对应的代码样例和使用场景，这就导致了开发人员看了不会用的情况出现，难以有效地帮助开发人员的学习。从开源社区的角度出发，一项对2000多名Eclipse和Mozilla开发人员的调查显示，近80％的参与者认为缺少代码样本及其使用场景是理解API的障碍。从商业企业的角度出发，对698名IBM开发人员和1000名微软开发人员进行了两次调查，结果表明，开发人员非常希望能够为尽可能多的API提供不同使用场景下的代码样本。大多程序员会借助诸如Google搜索引擎或是StackOverflow这样的开源社区来查找API的代码样例和使用场景，人工的查找和填充显然效率十分低下，而且评判标准不一，而通过自动化的方式将这些高质量的代码样例以及使用场景“移植”到API文档中显然是一种很理想的手段。

为此，研究人员从丰富API文档中使用场景和代码样例的角度出发，提出了API文档代码样例自动化填充的方法。通过网络收集原始数据，在经过使用场景提取和样例代码提取等一系列的处理之后把最终的数据嵌入API文档，生成新的API文档。对改善开发人员学习API文档的体验起了较大的帮助。

但是现在提出的API文档代码样例自动化填充的方法大多存在以下不足：通过搜索引擎获取原始数据，数据量过于庞大，无效信息过多，代码质量较低，或是通过下载技术论坛的Data Dump File并对其进行处理，普通用户难以自行获取Data Dump File，就无法对某一项具体技术的API文档进行定制化生成；API文档大多组织为HTML文档的形式，只能通过浏览器访问，并且内容比较复杂，不利于用户查阅。

发明内容

本发明的目的在于：针对现有方法的不足，提供一种能通过简易流程自动获取原始数据，加工原始数据，最后比较简明的带有使用场景和代码样例的本地API(API：应用程序接口)文档的用JavaFX进行代码样例自动填充的方法和工具。

为实现上述目的，本发明的技术方案是：提供一种用JavaFX进行代码样例自动填充的方法，包括以下步骤：

S1：访问不同的统一资源标识符，并且定位HTML文档中的元素，再爬取定位到元素中的文本内容，获取问题信息和应用程序接口信息；

S2：通过爬虫访问问题详细信息页面，提取使用场景，建立应用程序接口类型、使用场景和代码样例的映射，并将原始数据加工为符合文档要求的数据；S3：使用程序操作文档对象，通过代码逻辑预定义好文档模板和数据的组合形式，最后取出存储的数据嵌入文档，并保存生成最终的应用程序接口文档。

优选地，访问到不同的统一资源标识符和爬取文档元素内容的具体步骤包括：

S1-1：选择数据源，将某一具体技术对应映射设置一个标签，获取显示标签所对应具体技术的问题的网页的所有统一资源标识符；