Beyond syntax: enhancing automated documentation with data differences

Fantino, Giacomo

doi:10.1007/s10515-026-00623-y

Beyond syntax: enhancing automated documentation with data differences

2026-05-04

0

OA

AI

DOI：10.1007/s10515-026-00623-y

原文链接

原文求助

摘要

En 中文

现代软件开发的自动化主要基于人工智能，涵盖了从需求到测试和维护的整个软件开发生命周期中的代码生成和维护的各个方面，代码注释也不例外。自动代码注释生成方法依赖于源代码的静态语法和词汇特征。然而，这些方法在数据为中心的软件应用中表现不佳，因为在这些应用中，理解代码对数据的影响至关重要。我们探索了一种基于执行的自动文档生成扩展。在这项探索性工作中，我们旨在捕获执行后的数据转换（即语义数据差异），以揭示代码对数据的影响，并将其作为现有代码表示的补充信号，以自动化数据整理代码的解释性注释。我们从Kaggle构建了一个经过筛选的Python笔记本数据集，并应用轻量级执行跟踪器提取运行时数据转换的结构化描述。我们定义了一种形式文法来捕获这些影响，并使用协同注意机制将其集成到多模态编码器-解码器模型中。探索了多种训练策略，以评估这种新模态对注释生成的影响。我们的评估表明，采用这种模态的模型与仅代码的基线模型表现相当。值得注意的是，在未发生明显数据转换的情况下，符号性\documentclass[12pt]{minimal} \usepackage{amsmath} \usepackage{wasysym} \usepackage{amsfonts} \usepackage{amssymb} \usepackage{amsbsy} \usepackage{mathrsfs} \usepackage{upgreek} \setlength{\oddsidemargin}{-69pt} \begin{document}$$\langle \mathsf {no\_diff} angle$$\end{document}信号提高了鲁棒性和注释质量，这通过自动和人工评估指标均得到验证。然而，我们未观察到在语义丰富场景下注释质量的提升，这为未来研究方向提供了可能改进的途径。生成注释的定性分析支持这一模式，表明该模态通过减少中性情况下的不必要或推测性细节来稳定注释，但在发生有意义的数据转换时尚未提供一致的指导。这些趋势在一个更大、更嘈杂的扩展测试集上表现较弱，表明对注释-代码对齐的敏感性。我们的研究表明，将执行派生的反馈作为补充信号用于自动化注释生成是可行且具有潜力的。尽管当前方法受限于数据集大小和模态噪声，但它表明执行后的状态变化可以引导更具有上下文感知和稳定的代码摘要。这表明了一个有前景的方向，即执行敏感的模型可以辅助数据为中心的软件开发及其文档。

Keyword:

Automated comment generation

Data wrangling

Machine learning

Multimodal learning

Runtime code analysis

Beyond syntax: enhancing automated documentation with data differences

摘要

期刊

机构

引用论文