An Exploratory Study of API Usage Examples on the Web

被引:2
|
作者
Wang, Lijie [1 ]
Zou, Yanzhen
Fang, Lu
Xie, Bing
Yang, Fuqing
机构
[1] Peking Univ, Sch Elect Engn & Comp Sci, Software Inst, Beijing 100871, Peoples R China
基金
中国国家自然科学基金;
关键词
empirical study; API; usage examples; web search;
D O I
10.1109/APSEC.2012.122
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
Usage examples are helpful for programmers learning to use APIs from third-party frameworks or libraries. There are lots of usage examples scattered in web pages on the Web, such as tutorials, blogs, and forums. A few researches have proposed approaches to leveraging these usage examples to improve programming. However, due to the lack of comprehensive understanding on the current situation of usage examples on the web, the work is still at the very beginning. Many concerns are reserved, for instance, how many usage examples can be found on the Web? how well do such examples support programmers on earth? what factors have impact on these examples' usability? In this paper, we conducted an exploratory study of usage examples on the web, including their distribution, characteristics like content style, correctness, and complexity, as well as their correlations. Through the study, we obtain some insight of how to facilitate utilization of usage examples on the web and what mechanisms could be provided. Possible research directions and problems are proposed at the end.
引用
收藏
页码:396 / 405
页数:10
相关论文
共 50 条
  • [31] An Empirical Study of Web API Versioning Practices
    Serbout, Souhaila
    Pautasso, Cesare
    WEB ENGINEERING, ICWE 2023, 2023, 13893 : 303 - 318
  • [32] USE OF EXAMPLES IN CONJECTURING AND PROVING: AN EXPLORATORY STUDY
    Morselli, Francesca
    PME 30: PROCEEDINGS OF THE 30TH CONFERENCE OF THE INTERNATIONAL GROUP FOR THE PSYCHOLOGY OF MATHEMATICS EDUCATION, VOL 4, 2006, : 185 - 192
  • [33] An Empirical Study on the Reliability of the Web API Document
    Hosono, Masaki
    Washizaki, Hironori
    Fukazawa, Yoshiaki
    Honda, Kiyoshi
    2018 25TH ASIA-PACIFIC SOFTWARE ENGINEERING CONFERENCE (APSEC 2018), 2018, : 715 - 716
  • [34] Web API Usability: A Systematic Mapping Study
    Machini, Ariel
    Casas, Sandra
    INTERACTING WITH COMPUTERS, 2024,
  • [35] API documentation with executable examples
    Hoffman, D
    Strooper, P
    JOURNAL OF SYSTEMS AND SOFTWARE, 2003, 66 (02) : 143 - 156
  • [36] Improving API Documentation Using API Usage Information
    Stylos, Jeffrey
    Faulring, Andrew
    Yang, Zizhuang
    Myers, Brad A.
    2009 IEEE SYMPOSIUM ON VISUAL LANGUAGES AND HUMAN-CENTRIC COMPUTING, PROCEEDINGS, 2009, : 119 - 126
  • [37] Exploratory Study on Users' Behavior: Smartphone Usage
    Mutchler, Leigh A.
    Shim, J. P.
    Ormond, Dustin
    AMCIS 2011 PROCEEDINGS, 2011,
  • [38] An exploratory study on the usage of quantum programming languages
    Ferreira, Felipe
    Campos, Jose
    SCIENCE OF COMPUTER PROGRAMMING, 2025, 240
  • [39] Usage patterns of scholarly articles on Web of Science: a study on Web of Science usage count
    Xianwen Wang
    Zhichao Fang
    Xiaoling Sun
    Scientometrics, 2016, 109 : 917 - 926
  • [40] Usage patterns of scholarly articles on Web of Science: a study on Web of Science usage count
    Wang, Xianwen
    Fang, Zhichao
    Sun, Xiaoling
    SCIENTOMETRICS, 2016, 109 (02) : 917 - 926