Article Dans Une Revue International journal of advanced and applied sciences Année : 2019

Supporting software documentation with source code summarization

Résumé

Source code summarization is a process of generating summaries that describe software code, the majority of source code summarization usually generated manually, where the summaries are written by software developers. Recently, new automated approaches are becoming more useful. These approaches have been found to be effective in some cases. The main weaknesses of these approaches are that they never exploit code dependencies and summarize either the software classes or methods but not both. This paper proposes a source code summarization approach (Suncode) that produces a short description for each class and method in the software system. To validate the approach, it has been applied to several case studies. Moreover, the generated summaries are compared to summaries that written by human experts and to summaries that written by a state-of-the art solution. Results of this paper found that Suncode summaries provide better information about code dependencies comparing with other studies. In addition, Suncode summaries can improve and support the current software documentation. The results found that manually written summaries were more precise and short as well.

Fichier principal
Vignette du fichier
1021833ijaas201901008.pdf (1.78 Mo) Télécharger le fichier

Dates et versions

hal-04917774 , version 1 (05-02-2025)

Licence

Identifiants

Citer

Ra'Fat Al-Msie'Deen, Anas H Blasi. Supporting software documentation with source code summarization. International journal of advanced and applied sciences, 2019, 6 (1), pp.59 - 67. ⟨10.21833/ijaas.2019.01.008⟩. ⟨hal-04917774⟩
33 Consultations
74 Téléchargements

Altmetric

Partager

  • More