分析代码注释以提升程序理解
软件工程
2022-03-18 v2
摘要
我们试图找到能帮助程序员理解源代码 nontrivial 部分的源代码注释。此类例子之一是将赋零解释为“清空”缓冲区。这类注释对程序员极为宝贵，正确识别它们将大有助益。为此，我们开发了一种在源代码中发掘解释性代码注释的方法。我们首先提出十一种不同的代码注释类别。随后我们开发了基于决策树的分类器，能以60%的准确率和80%的召回率识别解释性注释。我们分析了用两种语言（Java和Python）编写的2000个GitHub项目。该任务的新颖之处在于聚焦于方法或函数内的微观注释（“局部注释”），而先前工作聚焦于API级或方法级注释。我们还调查了不同类别的注释在不同项目中的使用情况。我们的关键发现是存在两种主导类型的注释：前置条件与后置条件。我们的发现还表明，许多英文代码注释具有跨不同项目一致的某种语法结构。
引用
@article{arxiv.1905.02050,
title = {Analyzing Code Comments to Boost Program Comprehension},
author = {Yusuke Shinyama and Yoshitaka Arahori and Katsuhiko Gondow},
journal= {arXiv preprint arXiv:1905.02050},
year = {2022}
}