Design Annotations for Complementing Interfaces Targeting Effectiveness
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.
André L. Santos and Brad A. Myers, "Design Annotations to Improve API Discoverability", The Journal of Systems & Software, volume 126, April, 2017, Pages 17–33.
Copyright © 1996-2017 - Carnegie Mellon University - All Rights Reserved.