代码注释质量评估的十年研究：一项系统文献综述
软件工程
2023-04-26 v1
摘要
代码注释是软件系统中的重要制品，并在许多与维护和程序理解相关的软件工程（SE）任务中起着至关重要的作用。然而，尽管人们广泛认同代码注释中高质量的重要性如同源代码一样，但在实践中评估注释质量仍是一个开放问题。首先，在评估代码注释时，质量并没有唯一的定义。现有关于该主题的少数研究更侧重于可轻易量化和度量的特定质量属性。现有技术与相应工具也可能侧重于绑定到特定编程语言的注释，并且可能仅处理具有特定范围和明确目标（例如，方法级别的Javadoc注释，或描述待处理TODO的体内注释）的注释。在本文中，我们呈现了过去十年SE研究的系统文献综述（SLR），以回答以下研究问题：（i）研究者在评估注释质量时关注哪些类型的注释？（ii）他们考虑哪些质量属性（QAs）？（iii）他们使用哪些工具和技术来评估注释质量？以及（iv）他们总体上如何评估其关于注释质量评估的研究？我们基于2353篇论文的分析和实际评审其中47篇相关论文的评估表明：（i）大多数研究和技术聚焦于Java代码中的注释，因此可能无法推广到其他语言；（ii）所分析的研究聚焦于文献中确定的共21个质量属性里的4个主要质量属性，且明显以检查注释与代码之间的一致性为主。我们观察到研究者依赖于人工评估和特定启发式方法，而非对注释质量属性的自动化评估。
引用
@article{arxiv.2209.08165,
title = {A Decade of Code Comment Quality Assessment: A Systematic Literature Review},
author = {Pooja Rani and Arianna Blasi and Nataliia Stulova and Sebastiano Panichella and Alessandra Gorla and Oscar Nierstrasz},
journal= {arXiv preprint arXiv:2209.08165},
year = {2023}
}