arrow
返回

Prioritizing code documentation effort: Can we do it simpler but better?

delete2021-12-01
delete3
PRE
AI
S
Shiran Liu
Z
Zhaoqiang Guo
Y
Yanhui Li
H
Hongmin Lu
L
Lin Chen
L
Lei Xu
B
Baowen Xu
DOI:10.1016/j.infsof.2021.106686delete
delete原文链接
delete原文求助
delete分享
delete收藏
摘要

摘要

En 中文
Context: . Due to time or economic pressures, code developers are often unable to write documents for all modules in a project. Recently, a supervised artificial neural network (ANN) approach is proposed to prioritize documentation effort to ensure that sections of code important to program comprehension are thoroughly explained. Objective: . However, as a supervised approach, there is a need to use labeled training data to train the prediction model, which may not easy to obtain in practice. Furthermore, it is unclear whether the ANN approach is generalizable, as it is only evaluated on several small data sets collected from API libraries. Method: . In this paper, we propose an unsupervised approach based on improved PageRank to prioritize documentation effort. This approach identifies important modules only based on the dependence relationships between modules in a project. As a result, the PageRank approach does not need any training data to build the prediction model. Results: . In order to evaluate the effectiveness of the PageRank approach, we use six additional large data sets collected from two larger libraries and four applications to conduct the experiment. The experimental results show that the PageRank approach is superior to the state-of-the-art ANN approach. Conclusion: . Due to the simplicity and effectiveness, we advocate that the PageRank approach should be used as an easy-to-implement baseline in future research on documentation effort prioritization, and any newly proposed approach should be compared with it to demonstrate its effectiveness.
Keyword:
Code documentation
Program comprehension
PageRank
Metrics

期刊

Information and Software Technology 封面图
Information and Software Technology
IF:
4.3
论文数:
3.8K
被引数:
7.7K

机构

N
nanjing university
学者数:
7.8W
论文数: 5.6W
被引数: 87
引用论文

引用论文

The role of replications in empirical software engineering
err2008-01-29
err205
PREAI
errShull, Forrest J.; Carver, Jeffrey C.; Vegas, Sira; Juristo, Natalia
err分享
err收藏
Towards Prioritizing Documentation Effort
err2018-09-01
err20
errOAAI
errMcBurney, Paul W.; Jiang, Siyuan; Kessentini, Marouane; Kraft, Nicholas A.; Armaly, Ameer; Mkaouer, Mohamed Wiem; McMillan, Collin
err分享
err收藏
Asking and answering questions during a programming change task
err2008-07-01
err220
errOAAI
errSillito, Jonathan; Murphy, Gail C.; De Volder, Kris
err分享
err收藏
学者 查看更多内容