优质 TODO 注释是什么？
软件工程
2025-03-20 v1
摘要
软件开发是一种涉及个体和团队之间各种相互作用的协作过程。源代码中的TODO注释在管理和协调这一过程中的各种任务方面发挥着关键作用。然而，本研究发现，开源项目中大比例的TODO注释未得到解决或需要很长时间才能得到解决。约46.7%的开源存储库中的TODO注释质量较低（例如，含糊不清、缺乏信息或对开发人员无用的TODO）。这凸显了需要更好的TODO实践的需求。本研究调查了开源项目中TODO注释质量的四个方面：(1)低质量TODO注释的流行程度；(2)高质量TODO注释的关键特征；(3)不同质量TODO注释在实践中如何被管理；(4)自动评估TODO注释质量的可行性。通过检查来自Top100 GitHub Java存储库的2,863个TODO注释，我们提出了识别高质量TODO注释的准则，并提供了关于其最佳组成的见解。我们讨论了TODO注释的生命周期，具有不同质量。我们构建了基于深度学习的方法，这些方法在识别TODO注释质量方面表现前景， potentially enhance development efficiency and code quality.
引用
@article{arxiv.2503.15277,
title = {What Makes a Good TODO Comment?},
author = {Haoye Wang and Zhipeng Gao and Tingting Bi and John Grundy and Xinyu Wang and Minghui Wu and Xiaohu Yang},
journal= {arXiv preprint arXiv:2503.15277},
year = {2025}
}