类注释告诉我们什么？对 Pharo Smalltalk 中注释演化与实践的研究

先前的研究已对多种编程语言中的代码注释进行了特征描述，以支持更好的程序理解活动和维护任务。然而，很少有研究关注于理解开发者编写注释的实践。其中没有一项研究将此类开发者实践与标准注释指南进行比较，以研究开发者在多大程度上遵循了这些指南。本文报告了首个调查 Pharo Smalltalk 中注释实践的实证研究。首先，我们分析了七个 Pharo 版本中类注释的演化。然后，我们研究了类注释中嵌入的信息类型。最后，我们研究了跨 Pharo 版本的开发者注释实践对官方类注释模板的遵循程度。研究结果表明，在最初的三个 Pharo 版本中，类注释数量迅速增加，而在后续版本中，开发者同时为新类和旧类添加注释，从而保持了相似的代码与注释比率。我们进一步发现，类注释中的信息类型是模板建议的三倍。然而，模板建议的信息类型往往比其他类型的信息出现得更频繁。此外，我们发现相当大比例的注释在编写这些信息类型时遵循了模板的写作风格，但它们的编写和格式化方式并不统一。这表明需要标准化注释指南以格式化文本，并为不同的信息类型提供标题，以确保一致的风格并易于识别信息。鉴于高质量代码注释的重要性，我们为开发者和研究人员提出了许多启示，以改进对注释质量评估工具的支持。