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

Martin Monperrus 1, 2 Michael Eichberg 2 Elif Tekes 2 Mira Mezini 2
1 ADAM - Adaptive Distributed Applications and Middleware
LIFL - Laboratoire d'Informatique Fondamentale de Lille, Inria Lille - Nord Europe
Abstract : 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.
Type de document :
Article dans une revue
Empirical Software Engineering, Springer Verlag, 2012, 17 (6), pp.703-737. 〈10.1007/s10664-011-9186-4〉
Liste complète des métadonnées

Littérature citée [36 références]  Voir  Masquer  Télécharger

https://hal.inria.fr/hal-00702183
Contributeur : Martin Monperrus <>
Soumis le : mardi 29 mai 2012 - 15:00:26
Dernière modification le : jeudi 11 janvier 2018 - 06:22:13
Document(s) archivé(s) le : jeudi 15 décembre 2016 - 08:51:35

Fichiers

article.pdf
Fichiers produits par l'(les) auteur(s)

Identifiants

Collections

Citation

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, Springer Verlag, 2012, 17 (6), pp.703-737. 〈10.1007/s10664-011-9186-4〉. 〈hal-00702183〉

Partager

Métriques

Consultations de la notice

363

Téléchargements de fichiers

724