Please use this identifier to cite or link to this item:
http://hdl.handle.net/10071/13403
Author(s): | Santos, A. L. Myers, B. A. |
Date: | 2017 |
Title: | Design annotations to improve API discoverability |
Volume: | 126 |
Pages: | 17 - 33 |
ISSN: | 0164-1212 |
DOI (Digital Object Identifier): | 10.1016/j.jss.2016.12.036 |
Keywords: | API usability Annotations Code completion IDE Eclipse |
Abstract: | User studies have revealed that programmers face several obstacles when learning application programming interfaces (APIs). A considerable part of such difficulties relate to discovery of API elements and the relationships among them. To address discoverability problems, we show how to complement APIs with design annotations, which document design decisions in a program-processable form for types, methods, and parameters. The information provided by the annotations is consumed by the integrated development environment (IDE) in order to assist API users with useful code completion proposals regarding object creation and manipulation, which facilitate API exploration and learning. As a proof of concept, we developed Dacite, a tool which comprises a set of Java annotations and an accompanying plugin for the Eclipse IDE. A user study revealed that Dacite is usable and effective, and Dacite’s proposals enable programmers to be more successful in solving programming tasks involving unfamiliar APIs. |
Peerreviewed: | yes |
Access type: | Embargoed Access |
Appears in Collections: | ISTAR-RI - Artigos em revistas científicas internacionais com arbitragem científica |
Files in This Item:
File | Description | Size | Format | |
---|---|---|---|---|
Design annotations to improve API discoverability.pdf Restricted Access | Versão Editora | 2,81 MB | Adobe PDF | View/Open Request a copy |
Items in DSpace are protected by copyright, with all rights reserved, unless otherwise indicated.