通过代码文档等价进行以自然语言为中心的软件工程

源代码文档是软件开发和维护不可或缺的一部分，因为它有助于理解代码并促进开发人员之间的沟通。然而，现有文档通常不完整、过时或不准确，这可能会导致误解和错误。在广泛用于软件工程任务的 大语言模型 (LLM) 时代，文档的质量变得更加关键，因为文档为模型提供了重要的上下文。在本文中，我们介绍了文档到代码等价的概念，这是一种新颖的属性，可以捕获文档是否准确、完整地描述了它所记录的代码。我们提出了一种称为 Documentary 的新颖方法，可以为给定的代码片段自动生成等效文档。我们的评估表明 Documentary 可以为 53.4% 的评估函数级代码片段生成等效文档。为了展示文档到代码等效的好处，我们描述并评估了两项软件工程任务：代码理解和代码编辑。我们的结果表明，与人工编写的文档和基线方法生成的文档相比，文档到代码的等效性允许 LLM 预测函数输出的准确度提高 12.8--24.5%。此外，人类开发人员认为 Documentary 生成的文档比原始的人类编写的文档更有助于理解和编辑代码。