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.
翻译:每种编程语言都附有正式文件,用以指导开发商使用API、方法和类别,但在某些情况下,正式文件不是获取所需信息的有效途径,因此,开发商可以咨询其他来源(如Stack Overflow、GitHub)了解更多关于API、其实施、使用和正式文件可能无法提供的其他信息。在这项研究中,我们建议采用自动办法,利用非官方文件技术,生成API摘要和方法。我们的调查结果表明,生成的摘要具有竞争性,可以用作指导开发商开发和维护软件任务的补充来源。