Java 代码注释中有关基本类型变量的知识特征刻画
软件工程
2021-05-20 v1
摘要
基本类型是任何编程语言中都存在的基础组件，是数据操作的构建块。理解这些类型在源代码中的作用对于编写软件至关重要。关于这些变量在代码注释中被文档化的频率以及注释提供了关于基本类型变量的何种知识，已有研究甚少。在本文中，我们提出了一种利用词法匹配和高级匹配来检测基本类型变量及其在注释中描述的方法。我们通过将词法匹配与高级匹配的召回率、精确率和 F 值性能，与来自 GitHub 项目样本的 600 个手动标注变量进行比较，来评估我们的方法。我们基于 F 值的高级方法性能优于词法匹配，分别为 0.986 和 0.942。随后，我们构建了这些注释中关于基本类型变量所含知识类型的分类体系。我们的研究表明，开发者通常对数值数据类型的变量标识符以其用途（69.16%）和概念（72.75%）进行文档化，多于 String 类型的变量标识符，后者以用途（61.14%）和概念（55.46%）文档化的比例较低。我们的发现刻画了当前文档化基本类型变量的实践现状，并指出了往往文档化不佳的方面，例如布尔变量的含义或字段与局部变量的用途。
引用
@article{arxiv.2103.12291,
title = {Characterising the Knowledge about Primitive Variables in Java Code Comments},
author = {Mahfouth Alghamdi and Shinpei Hayashi and Takashi Kobayashi and Christoph Treude},
journal= {arXiv preprint arXiv:2103.12291},
year = {2021}
}