What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation - Archive ouverte HAL Accéder directement au contenu
Article Dans Une Revue Empirical Software Engineering Année : 2012

What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation

Résumé

Application Programming Interfaces (API) are exposed to developers in order to reuse software libraries. API directives are natural-language statements in API documentation that make developers aware of constraints and guidelines related to the usage of an API. This paper presents the design and the results of an empirical study on the directives of API documentation of object-oriented libraries. Its main contribution is to propose and extensively discuss a taxonomy of 23 kinds of API directives.
Fichier principal
Vignette du fichier
article.pdf (375.88 Ko) Télécharger le fichier
Origine : Fichiers produits par l'(les) auteur(s)
Loading...

Dates et versions

hal-00702183 , version 1 (29-05-2012)

Identifiants

Citer

Martin Monperrus, Michael Eichberg, Elif Tekes, Mira Mezini. What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation. Empirical Software Engineering, 2012, 17 (6), pp.703-737. ⟨10.1007/s10664-011-9186-4⟩. ⟨hal-00702183⟩
263 Consultations
655 Téléchargements

Altmetric

Partager

Gmail Facebook X LinkedIn More