从技术问答站点自动生成 API 使用场景文档
软件工程
2021-02-18 v1
摘要
在线技术问答站点 Stack Overflow（SO）在开发者中很受欢迎，用于支持其编码和多样化开发需求。为解决 API 官方文档资源的不足，若干研究聚焦于利用 SO 中的洞见（例如代码示例）来增强官方 API 文档。这些技术提议将关于 API 的代码例/洞见添加到其官方文档中。评论是带有正/负情感的有观点句子。然而，据我们所知，此前尚无研究尝试通过同时考虑 API 代码示例和评论来从 SO 自动生成 API 文档。在本文中，我们提出两种新颖算法，可通过结合代码示例及针对这些示例的评论，从 SO 自动生成 API 文档。第一种算法称为统计文档，其使用不同度量（例如星级评分）展示 API 代码例周围正负面情感的分布。第二种算法称为基于概念的文档，其对相似且概念相关的使用场景进行聚类。一个 API 使用场景包含代码示例、代码例所解决底层任务 textual 描述，以及其他开发者针对该代码示例的评论（即带有正负面情感的观点）。我们将这些算法部署于 Opiner——一个从在线论坛聚合 API 信息的基于 web 的平台。我们通过挖掘 SO 中所有基于 Java JSON 的帖子，并基于所生成文档开展三项用户研究，对算法进行了评估。
引用
@article{arxiv.2102.08502,
title = {Automatic API Usage Scenario Documentation from Technical Q&A Sites},
author = {Gias Uddin and Foutse Khomh and Chanchal K Roy},
journal= {arXiv preprint arXiv:2102.08502},
year = {2021}
}