Supporting software documentation with source code summarization

12/14/2018
by   Ra'Fat Al-Msie'deen, et al.
0

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.

READ FULL TEXT
research
08/26/2021

Retrieval Augmented Code Generation and Summarization

Software developers write a lot of source code and documentation during ...
research
02/26/2021

Neural Code Summarization

Code summarization is the task of generating readable summaries that are...
research
03/08/2019

Developer Reading Behavior While Summarizing Java Methods: Size and Context Matters

An eye-tracking study of 18 developers reading and summarizing Java meth...
research
07/18/2023

Is this Snippet Written by ChatGPT? An Empirical Study with a CodeBERT-Based Classifier

Since its launch in November 2022, ChatGPT has gained popularity among u...
research
11/27/2021

Leveraging Unsupervised Learning to Summarize APIs Discussed in Stack Overflow

Automated source code summarization is a task that generates summarized ...
research
12/11/2018

Generating Summaries for Methods of Event-Driven Programs: an Android Case Study

Developers often dedicate a great amount of time to program comprehensio...
research
05/06/2019

Toward Human-Like Summaries Generated from Heterogeneous Software Artefacts

Automatic text summarisation has drawn considerable interest in the fiel...

Please sign up or login with your details

Forgot password? Click here to reset