Can Code Metrics Enhance Documentation Generation for Computational Notebooks?

In software development, code documentation is crucial for collaboration and maintenance, especially as projects become more complex. However, it is often neglected due to the tedious effort it requires. This paper explores automating documentation generation for computational notebooks, focusing on the impact of code metrics such as lines of code, API popularity, and complexity on this task. Using a dataset of 22K code-documentation pairs, we compare deep learning models with and without code metric augmentation. The results show that incorporating these metrics significantly improves the accuracy of documentation generation, underscoring the connection between code metrics and quality documentation.

Authors

Institutions

Publication Details

Published
2024-10-18
DOI
https://doi.org/10.1145/3691620.3695334
Citations
1
Primary Topic
Natural Language Processing Techniques
Type
article
Field-Weighted Citation Impact
0.35
Controls
|||
ALL TIME
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
article

Can Code Metrics Enhance Documentation Generation for Computational Notebooks?

Mojtaba Mostafavi Ghahfarokhi, Abbas Heydarnoori, Ashkan Khademian, Sepehr Kianiangolafshani et al.
1 citations
Natural Language Processing Techniques
0.35
article

Can Code Metrics Enhance Documentation Generation for Computational Notebooks?

Mojtaba Mostafavi Ghahfarokhi, Abbas Heydarnoori, Ashkan Khademian, Sepehr Kianiangolafshani, Hamed Jahantigh, Alireza Asadi
article en
1 citations

Abstract

In software development, code documentation is crucial for collaboration and maintenance, especially as projects become more complex. However, it is often neglected due to the tedious effort it requires. This paper explores automating documentation generation for computational notebooks, focusing on the impact of code metrics such as lines of code, API popularity, and complexity on this task. Using a dataset of 22K code-documentation pairs, we compare deep learning models with and without code metric augmentation. The results show that incorporating these metrics significantly improves the accuracy of documentation generation, underscoring the connection between code metrics and quality documentation.

Sharif University of Technology (IR)
Quality Education
Openalex Percentile: Top 33%
Natural Language Processing Techniques
0.35
AI Navigator

Ask Laika to Summarize, Analyze, and Connect papers live on the map.

Summarize Papers & Methodologies

Extract key findings, datasets, and comparative methods across publications.

Benchmark Rankings & Visual Analytics

Rank top research institutions, authors, funders, topics, and journals by Field-Weighted Citation Impact (FWCI) and paper volume with instant charts.

Connect Distant Disciplines

Bridge topological clusters on the map to find hidden collaborative intersections.