你的注释过时了吗？自动检测代码注释一致性
软件工程
2024-03-04 v1
摘要
在软件开发和维护中，代码注释可以帮助开发者理解源代码，并改善开发者之间的沟通。然而，开发者在更改代码时有时会忘记更新相应的注释，导致注释过时（即代码和注释不一致）。过时的注释是危险且有害的，可能会误导后续的开发者。更严重的是，过时的注释有时可能导致致命的缺陷。为了自动识别源代码中的过时注释，我们提出了一种基于学习的方法，称为CoCC，用于检测代码和注释之间的一致性。为了高效识别过时注释，我们从代码和注释变更前后提取了多个特征。此外，我们还在模型中考虑了代码和注释之间的关系。实验结果表明，CoCC能够有效检测过时注释，精确率超过90%。此外，我们识别了导致注释过时的15个最重要因素，并验证了CoCC在不同编程语言中的适用性。我们还使用CoCC在开源项目的最新提交中发现了过时注释，进一步证明了所提方法的有效性。
引用
@article{arxiv.2403.00251,
title = {Are your comments outdated? Towards automatically detecting code-comment consistency},
author = {Yuan Huang and Yinan Chen and Xiangping Chen and Xiaocong Zhou},
journal= {arXiv preprint arXiv:2403.00251},
year = {2024}
}