• 主题
高级搜索  >
历史搜索 清空历史
首页> 外文期刊>IEEE Transactions on Software Engineering >Automatic Detection and Update Suggestion for Outdated API Names in Documentation
【24h】

Automatic Detection and Update Suggestion for Outdated API Names in Documentation

机译：自动检测和更新文档中过时API名称的建议

获取原文
获取原文并翻译 | 示例
           
页面导航
  • 摘要
  • 著录项
  • 相似文献
  • 相关主题

摘要

Application programming interfaces (APIs) continually evolve to meet ever-changing user needs, and documentation provides an authoritative reference for their usage. However, API documentation is commonly outdated because nearly all of the associated updates are performed manually. Such outdated documentation, especially with regard to API names, causes major software development issues. In this paper, we propose a method for automatically updating outdated API names in API documentation. Our insight is that API updates in documentation can be derived from API implementation changes between code revisions. To evaluate the proposed method, we applied it to four open source projects. Our evaluation results show that our method, FreshDoc, detects outdated API names in API documentation with 48 percent higher accuracy than the existing state-of-the-art methods do. Moreover, when we checked the updates suggested by FreshDoc against the developers' manual updates in the revised documentation, FreshDoc detected 82 percent of the outdated names. When we reported 40 outdated API names found by FreshDoc via issue tracking systems, developers accepted 75 percent of the suggestions. These evaluation results indicate that FreshDoc can be used as a practical method for the detection and updating of API names in the associated documentation.
机译：应用程序编程接口（API）不断发展以满足更改的用户需求，文档为其使用提供了权威参考。但是，API文档通常已经过时，因为几乎所有关联的更新都是手动执行的。如此过时的文档，特别是关于API名称，导致主要的软件开发问题。在本文中，我们提出了一种在API文档中自动更新过时的API名称的方法。我们的洞察力是文档中的API更新可以从代码修订之间的API实现更改派生。为了评估所提出的方法，我们将其应用于四个开源项目。我们的评估结果表明，我们的方法，FreshDoc，在API文档中检测到过时的API名称，比现有的最先进的方法更高的精度更高。此外，当我们检查Freshdoc对开发人员手动更新的新订文档中的更新时，Freshdoc检测到未过时的名称的82％。当我们通过问题跟踪系统报告Breshdoc发现的40个过时的API名称时，开发人员接受了75％的建议。这些评估结果表明，Freshdoc可以用作检测和更新相关文档中API名称的实用方法。

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
获取原文

客服邮箱：kefu@zhangqiaokeyan.com

京公网安备：11010802029741号 ICP备案号：京ICP备15016152号-6 六维联合信息科技 (北京) 有限公司©版权所有

  • 客服微信

  • 服务号