等等,那段代码之前不是在这里吗?检测过时的软件文档
软件工程
2023-07-11 v1
摘要
在软件工程领域,开发者和用户遇到过时文档并非罕见。为确保软件文档与时俱进,开发者往往不得不在源代码发生变更时手动检查文档是否需要更新。在我们之前的工作中,提出了一种自动检测软件仓库中过时代码元素引用的方法,并发现 GitHub 上 1000 个最热门项目中有超过四分之一至少包含一个过时引用。本文提出一个基于我们之前工作方法的 GitHub Actions 工具,GitHub 开发者可配置该工具,在提交拉取请求时自动扫描其 GitHub 项目文档中的过时代码元素引用。
引用
@article{arxiv.2307.04291,
title = {Wait, wasn't that code here before? Detecting Outdated Software Documentation},
author = {Wen Siang Tan and Markus Wagner and Christoph Treude},
journal= {arXiv preprint arXiv:2307.04291},
year = {2023}
}