arrow
返回

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
delete原文链接
delete原文求助
delete分享
delete收藏
摘要

摘要

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.
Keyword:
Summarization
software documentation
source code
deep learning
summary generation
name prediction

期刊

ACM Transactions on Intelligent Systems and Technology 封面图
ACM Transactions on Intelligent Systems and Technology
IF:
6.6
论文数:
1.5K
被引数:
6.2K

机构

引用论文

引用论文

err
IF0
err
err0
errOAAI
err
err分享
err收藏
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
err分享
err收藏
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
err分享
err收藏
err分享
err收藏
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
err分享
err收藏
学者 查看更多内容