CoDocent: Support API Usage with Code Example and API Documentation

CoDocent: Support API Usage with Code Example and API Documentation
复制标题

DOI:
10.1109/icsea.2010.28
复制
发表时间:
2010-08
期刊:
2010 Fifth International Conference on Software Engineering Advances
影响因子:
--
通讯作者:
Y. Wu;Lee Wei Mar;H. C. Jiau
Y. Wu;Lee Wei Mar;H. C. Jiau
中科院分区:
其他
文献类型:
--
作者:
Y. Wu;Lee Wei Mar;H. C. Jiau

文献摘要

被引文献

相似文献

API文档和代码示例是支持API使用的两个主要资源。为了找到在特定编程任务中使用API的最佳方式,链接相关API的有效策略变得至关重要。目前,许多代码搜索引擎已经被提出来解决这个问题。通过这些搜索结果,程序员必须手动遍历所有API文档以了解所引用的API调用。为了确保API编程风格的生产力,这项工作提供了CoDocent来帮助程序员审查搜索引擎找到的代码示例。对于每个找到的代码示例,CoDocent可以自动链接相关的API文档,以提供作为抽象的图表来反映API调用的语义。进行两个评估,以显示CoDocent在调查和适应API调用的代码示例的有效性。
API documentation and code example are two major resources to support API usage. To find the best way to use APIs within specific programming tasks, an effective strategy to link related APIs becomes critical. Currently, many code search engines have been proposed to solve this issue. Through those search results, programmers must manually traverse across all API documents to learn the referred API calls. To ensure the productivity in the style of programming with APIs, this work provides CoDocent to help programmers review code examples found by search engines. For each found code example, CoDocent can automatically link related API documents to provide diagrams as abstractions to reflect the semantics of API calls. Two evaluations are conducted to show the effectiveness of CoDocent in investigating and adapting API calls from code examples.