Documentation Reuse: Hot or Not? An Empirical Study - Archive ouverte HAL Accéder directement au contenu
Communication Dans Un Congrès Année : 2017

Documentation Reuse: Hot or Not? An Empirical Study

Résumé

Having available a high quality documentation is critical for software projects. This is why documentation tools such as Javadoc are so popular. As for code, documentation should be reused when possible to increase developer productivity and simplify maintenance. In this paper, we perform an empirical study of duplications in JavaDoc documentation on a corpus of seven famous Java APIs. Our results show that copy-pastes of JavaDoc documentation tags are abundant in our corpus. We also show that these copy-pastes are caused by four different kinds of relations in the underlying source code. In addition, we show that popular documentation tools do not provide any reuse mechanism to cope with these relations. Finally, we make a proposal for a simple but efficient automatic reuse mechanism.
Fichier principal
Vignette du fichier
main.pdf (305.97 Ko) Télécharger le fichier
Origine : Fichiers produits par l'(les) auteur(s)
Loading...

Dates et versions

hal-02182142 , version 1 (06-01-2020)

Identifiants

Citer

Mohamed Oumaziz, Alan Charpentier, Jean-Rémy Falleri, Xavier Blanc. Documentation Reuse: Hot or Not? An Empirical Study. 16th International Conference on Software Reuse (ICSR), May 2017, Salvador, Brazil. pp.12-27, ⟨10.1007/978-3-319-56856-0_2⟩. ⟨hal-02182142⟩

Collections

CNRS
50 Consultations
185 Téléchargements

Altmetric

Partager

Gmail Facebook X LinkedIn More