初级编程中的代码质量缺陷

《ACM Transactions on Computing Education》：Code Quality Defects in Introductory Programming

代码质量缺陷在编程教育中的重要性及系统化研究。本文构建了包含108个缺陷的分类目录，按类型（如未使用、简化可行等）和编程结构（如条件、循环等）组织，并通过教育者调查评估严重性，发现"代码无效果"和"全局变量"普遍严重。开发了EduLint工具检测这些缺陷，并分析多数据集发现缺陷普遍性受任务选择、教学规则等影响。研究为教学干预和工具开发提供依据。

　　在编程教育中，代码质量是一个至关重要的方面。高质量的代码不仅更容易维护，而且整体上降低了软件开发和维护的长期成本。因此，将代码质量作为编程教学的重点具有重要意义。然而，尽管已有大量研究识别了学生在编写代码时常犯的错误类型，但这些错误尚未得到系统的分类和优先级排序。本研究旨在从多个角度系统性地探讨初级编程中的代码质量缺陷，提供一个全面的代码质量缺陷目录，并通过调查计算机科学教育工作者对各种缺陷严重程度的看法，为教学和工具开发提供指导。

代码质量缺陷通常指代码在功能上是正确的，但在可读性、可维护性和可扩展性方面存在不足。例如，一个学生可能会写出冗余的if-else结构，或者在代码中包含不必要的注释。这些错误虽然不会导致程序无法运行，但会显著影响代码的清晰度和效率。因此，识别和纠正这些缺陷对于提高学生的编程能力至关重要。然而，目前缺乏一个统一的框架来组织这些缺陷，导致不同研究之间的可比性较低。

本研究的核心贡献是一个包含108种代码质量缺陷的系统化目录。该目录不仅列出了各种缺陷的名称和描述，还提供了检测方法、语言独立性、严重程度和普遍性等属性。这些属性帮助教育工作者和工具开发者理解缺陷的性质，并据此制定教学策略或开发检测工具。例如，某些缺陷如“无效果的代码”被普遍认为严重，而“非英文变量名”则在严重程度上存在较大分歧。这种分类有助于识别哪些缺陷值得优先关注，以及哪些缺陷可能对教学实践和工具开发更有价值。

为了构建这一目录，研究团队采用了迭代的方法，结合了多种来源的代码质量缺陷。在最初的版本中，他们通过分析在线学习环境中的代码收集了32个缺陷。随着研究的深入，他们逐步扩展了目录，最终达到了108个缺陷。这种迭代方法确保了目录的全面性和实用性。同时，团队还排除了一些与功能正确性密切相关或特定于其他编程语言的缺陷，以专注于Python这一在初级编程中广泛使用的语言。

本研究还通过调查教育工作者对不同代码质量缺陷的严重程度的看法，为缺陷的优先级排序提供了依据。调查结果显示，尽管个体意见存在差异，但教育工作者在某些缺陷的严重性上达成了共识。例如，几乎所有受访者都认同“无效果的代码”是一个严重的缺陷，而“常量在比较中优先”则被许多人认为不重要。这些结果表明，虽然代码质量评估具有一定的主观性，但存在一些普遍认可的缺陷类型，这为教学和工具开发提供了基础。

在检测方法方面，研究团队分析了现有的代码质量检测工具，并将其分为三种主要类型：基于模式的检测、基于静态分析的检测和基于语义的检测。基于模式的检测通常涉及简单的正则表达式或抽象语法树（AST）分析，适用于大多数缺陷类型。基于静态分析的检测则更复杂，涉及对代码结构和依赖关系的深入分析，适用于一些需要更广泛理解的缺陷。基于语义的检测则要求理解代码的整体功能，这通常需要使用机器学习技术，如大型语言模型（LLMs），来识别代码中的深层问题。

研究团队还开发了一种新的教育工具EduLint，它结合了现有的专业工具，并增加了针对初级编程的自定义检测器。EduLint能够检测广泛的代码质量缺陷，并且是开源的，易于使用和集成。它支持命令行、网页界面、IDE插件和API等多种使用方式，使得教育工作者能够灵活地将代码质量检测融入教学过程中。

此外，研究团队分析了不同数据集中的代码质量缺陷，发现缺陷的普遍性因数据集而异。例如，某些数据集中的学生可能更频繁地犯“条件判断”或“循环结构”相关的错误，而其他数据集中的学生可能更倾向于“变量命名”或“代码格式”方面的缺陷。这种差异可能与任务设计、教学环境和学生经验水平有关。因此，研究团队建议在分析缺陷普遍性时，应考虑这些上下文因素，并使用条件普遍性指标来更准确地评估缺陷的发生频率。

总体而言，本研究为编程教育提供了重要的资源和指导。通过系统化的代码质量缺陷目录，教育工作者可以更好地识别和纠正学生代码中的常见问题，而工具开发者则可以利用这些信息开发更有效的检测工具。此外，研究还揭示了代码质量评估的主观性和上下文依赖性，强调了在评估缺陷普遍性时需要考虑多种因素。未来的研究可以进一步探索这些缺陷的检测方法，特别是在语义层面的检测，以及如何将这些发现应用于更广泛的编程教学环境中。