论文标题
使用NLP技术基于非官方文档的API迈向代码摘要
Towards Code Summarization of APIs Based on Unofficial Documentation Using NLP Techniques
论文作者
论文摘要
每种编程语言都有正式文档，以指导开发人员使用API，方法和类。但是，在某些情况下，官方文档不是获取所需信息的有效方法。结果，开发人员可以咨询其他来源（例如，堆栈溢出，GitHub），以了解有关API的更多信息，其实施，用法和其他官方文档可能无法提供的信息。在这项研究中，我们提出了一种自动方法，通过使用NLP技术利用非正式文档来生成API和方法的摘要。我们的发现表明，生成的摘要具有竞争力，可以用作指导开发人员软件开发和维护任务的补充来源。
Each programming language comes with official documentation to guide developers with APIs, methods, and classes. However, in some cases, official documentation is not an efficient way to get the needed information. As a result, developers may consult other sources (e.g., Stack Overflow, GitHub) to learn more about an API, its implementation, usage, and other information that official documentation may not provide. In this research, we propose an automatic approach to generate summaries for APIs and methods by leveraging unofficial documentation using NLP techniques. Our findings demonstrate that the generated summaries are competitive, and can be used as a complementary source for guiding developers in software development and maintenance tasks.
