TU Darmstadt / ULB / TUbiblio

What should developers be aware of? An empirical study on the directives of API documentation

Monperrus, Martin ; Eichberg, Michael ; Tekes, Elif ; Mezini, Mira :
What should developers be aware of? An empirical study on the directives of API documentation.
[Online-Edition: http://dx.doi.org/10.1007/s10664-011-9186-4]
In: Empirical Software Engineering pp. 1-35. ISSN 1382-3256
[Artikel], (2012)

Offizielle URL: http://dx.doi.org/10.1007/s10664-011-9186-4

Kurzbeschreibung (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.

Typ des Eintrags: Artikel
Erschienen: 2012
Autor(en): Monperrus, Martin ; Eichberg, Michael ; Tekes, Elif ; Mezini, Mira
Titel: What should developers be aware of? An empirical study on the directives of API documentation
Sprache: Englisch
Kurzbeschreibung (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.

Titel der Zeitschrift, Zeitung oder Schriftenreihe: Empirical Software Engineering
Verlag: Springer Netherlands
Fachbereich(e)/-gebiet(e): Fachbereich Informatik > Softwaretechnik
Fachbereich Informatik
Hinterlegungsdatum: 15 Feb 2012 14:14
Offizielle URL: http://dx.doi.org/10.1007/s10664-011-9186-4
ID-Nummer: 10.1007/s10664-011-9186-4
Export:

Optionen (nur für Redakteure)

Eintrag anzeigen Eintrag anzeigen