开发者如何提升代码可读性？一项关于拉取请求的实证研究
软件工程
2023-09-07 v1
摘要
已有可读性模型与工具被提出以衡量阅读代码的代价。然而，这些模型并不能完全捕捉开发者所感知的代码质量改进。为探究面向新可读性模型与生产可用工具的潜在特征，我们旨在更好地理解开发者在实际提升代码可读性时所进行的可读性改进类型，并识别自动静态工具的建议与开发者实际改进之间的偏差。我们从109个GitHub仓库的284个已合并拉取请求（PR）中收集了370项代码可读性改进，并生成了一份包含26种不同代码可读性改进类型的目录，其中在大多数场景下，开发者将代码可读性改进得更为直观、模块化且更简洁。令人惊讶的是，SonarQube仅检测到了370项代码可读性改进中的26项。这表明所生成的目录中部分内容尚未被SonarQube规则覆盖，凸显了自动静态分析工具（ASAT）代码可读性规则在开发者感知层面上的改进潜力。
引用
@article{arxiv.2309.02594,
title = {How do Developers Improve Code Readability? An Empirical Study of Pull Requests},
author = {Carlos Eduardo C. Dantas and Adriano M. Rocha and Marcelo A. Maia},
journal= {arXiv preprint arXiv:2309.02594},
year = {2023}
}