开发者在讨论什么关于代码注释的内容？

代码注释对于程序理解、开发和运维任务十分重要。鉴于代码注释标准不一且其非结构化或半结构化特性，开发者（尤其是新手开发者）容易对编写文档时应遵循的约定或使用的工具感到困惑。因此，他们在外部在线资源上发布相关问题以寻求更好的注释实践。本文中，我们分析了 Stack Overflow（SO）和 Quora 等在线资源上关于代码注释的讨论，以揭示开发者就注释实践所提出的问题。我们应用潜在狄利克雷分配（LDA）来识别有关代码注释的新兴主题。随后我们手动分析一组具有统计显著性的帖子样本，推导出一套分类法，概览开发者关于注释实践的问题。我们的结果强调，在 SO 上近 40% 的问题提及如何在文档工具和环境里编写或处理注释，近 20% 的问题关于文档工具自动且一致地在注释中添加更多信息的潜在局限与可能。另一方面，在 Quora 上，开发者问题更多聚焦于背景信息（35% 的问题）或征询关于代码注释的意见（16% 的问题）。我们发现：（i）并非注释的所有方面都涵盖于编码风格指南中，例如如何添加特定类型的信息；（ii）开发者需要支持以学习在注释中添加各类信息的语法和格式约定；（iii）开发者对各种注释自动化策略（如坏注释检测或自动校验注释风格）感兴趣，但缺乏相应工具支持。