中文

Jupyter Notebook 中的方法名:一项探索性研究

软件工程 2025-04-30 v1

摘要

方法名在传达其功能的目的和行为方面起着重要作用。研究表明,高质量的命名能够显著提升代码理解以及软件的整体可维护性。然而,这些研究主要聚焦于传统软件开发中的命名实践。关于 Jupyter Notebook(一种流行的科学计算与数据分析环境)中命名模式的研究十分有限。在这项探索性研究中,我们分析了 384 个 Jupyter Notebook 中 691 个方法的命名实践,重点关注三个关键方面:命名风格约定、语法构成以及缩写与首字母缩略词的使用。我们的发现揭示了 Notebook 方法名的鲜明特征,包括对简洁性的偏好以及对传统命名模式的偏离。我们识别出 68 种独特的语法模式,其中仅 55.57% 的方法以动词开头。进一步分析显示,一半具有 return 语句的方法不以动词开头。我们还发现 30.39% 的方法名包含缩写或首字母缩略词,涉及数学或统计学术语以及图像处理概念等。我们期望我们的发现能够促进开发专门用于评估和推荐科学代码高质量命名的工具与技术,并为 Notebook 开发社区量身打造教育资源。

关键词

引用

@article{arxiv.2504.20330,
  title  = {Method Names in Jupyter Notebooks: An Exploratory Study},
  author = {Carol Wong and Gunnar Larsen and Rocky Huang and Bonita Sharif and Anthony Peruma},
  journal= {arXiv preprint arXiv:2504.20330},
  year   = {2025}
}

备注

The 33rd IEEE/ACM International Conference on Program Comprehension (ICPC 2025) - Research Track