格式化元素对代码易读性影响的系统性文献综述

背景：软件程序可以以不同但功能等价的方式编写。尽管先前研究已比较特定格式化元素以发现哪些替代方案影响代码易读性，但把握何种因素使代码更易或更难读的整体图景仍具挑战。目标：我们旨在找出在实证研究中已被调查的格式化元素，以及哪些替代方案被发现对人类受试者更具易读性。方法：我们进行了系统性文献综述，识别出 15 篇包含以人为中心、直接比较替代格式化元素的研究论文。我们使用卡片分类法分析并组织了这些格式化元素。结果：我们识别出 13 个格式化元素（如缩进）和 33 个格式化元素层级（如两空格缩进），涉及格式化风格、间距、块分隔符、长或复杂代码行以及词边界风格。虽然某些层级在代码易读性上被发现统计显著优于其他等价层级（如带代码块适当使用缩进），其他则不然（如格式化布局）。对于标识符风格，我们发现分歧结果：一项研究发现在驼峰命名法上有显著差异偏好，而另一项研究发现对蛇形命名法有正向结果。结论：所识别论文的数量（其中部分已过时）以及大量空结果与矛盾结果，凸显了该领域相对缺乏研究，并强调了更多研究的重要性。在创建指导原则和自动化辅助工具以帮助开发者提升代码易读性之前，关于格式化元素如何影响代码易读性尚有诸多待理解之处。