arrow
Return

A Review on Source Code Documentation

delete2022-06-21
delete11
PRE
AI
S
Sawan Rai *
R
Ramesh Chandra Belwal
A
Atul Gupta
DOI:10.1145/3519312delete
deleteOriginal
deleteOriginal request for help
deleteShare
deleteSave
Abstract

Abstract

En 中文
Context: Coding is an incremental activity where a developer may need to understand a code before making suitable changes in the code. Code documentation is considered one of the best practices in software development but requires significant efforts from developers. Recent advances in natural language processing and machine learning have provided enough motivation to devise automated approaches for source code documentation at multiple levels. Objective: The review aims to study current code documentation practices and analyze the existing literature to provide a perspective on their preparedness to address the stated problem and the challenges that lie ahead. Methodology: We provide a detailed account of the literature in the area of automated source code documentation at different levels and critically analyze the effectiveness of the proposed approaches. This also allows us to infer gaps and challenges to address the problem at different levels. Findings: (1) The research community focused on method-level summarization. (2) Deep learning has dominated the past five years of this research field. (3) Researchers are regularly proposing bigger corpora for source code documentation. (4) Java and Python are the widely used programming languages as corpus. (5) Bilingual Evaluation Understudy is the most favored evaluation metric for the research persons.
Keywords:
Summarization
software documentation
source code
deep learning
summary generation
name prediction

Journal

ACM Transactions on Intelligent Systems and Technology cover
ACM Transactions on Intelligent Systems and Technology
IF:
6.6
Papers:
1.5K
Citations:
6.2K

Organization

Cited Papers

Cited Papers

err
IF0
err
err0
errOAAI
err
errShare
errSave
Homeobox Gene Involvement in Normal Hematopoiesis and in the Pathogenesis of Childhood Leukemias
err2017-01-01
err0
PREAI
errMaria Adamaki; Maria Goulielmaki; Ioannis Christodoulou; Spiros Vlahopoulos; Vassilis Zoumpourlis
errShare
errSave
Contemplating the Pentagon Attack After Five Years of Space and Time: Unheard Voices From the Ramparts of Our Burn Center
err2006-09-01
err0
PREAI
errJames C. Jeng; Kathleen Hollowed; Christine T. Owen; Anne G. Rizzo; Tammi Royce; Jack Sava; Arthur St. Andre; Patricia White; Timothy D. Light; Marion H. Jordan
errShare
errSave
errShare
errSave
Effects of isopropyl alcohol, ethanol, and polyethylene glycol/industrial methylated spirits in the treatment of acute phenol burns
err1992-11-01
err0
PREAI
errDavid M Hunter; Beverly L Timerding; Ralph B Leonard; Timothy H McCalmont; Earl Schwartz
errShare
errSave
Atmospheric History of H2 Over the Past Century Reconstructed From South Pole Firn Air
err2020-07-16
err0
errOAAI
errJ. D. Patterson; M. Aydin; A. M. Crotwell; G. Petron; J. P. Severinghaus; E. S. Saltzman
errShare
errSave
researcher View more