返回
Prioritizing code documentation effort: Can we do it simpler but better?
DOI:10.1016/j.infsof.2021.106686.png)
摘要
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
期刊
IF:
4.3
论文数:
3.8K
被引数:
7.7K
机构
引用论文
A Systematic Literature Review on Fault Prediction Performance in Software Engineering软件工程中故障预测性能的系统文献综述
A Comprehensive Investigation of the Role of Imbalanced Learning for Software Defect Prediction对不平衡学习在软件缺陷预测中的作用的综合研究

