paperbot · PL 论文追踪

全部论文 待读 收藏

P2 On Indirectly Dependent Documentation in the Context of Code Evolution: A Study

代码演化背景下间接依赖文档的研究
ICSE 2021 IEEE/ACM 43rd International Conference on Software Engineering (ICSE)2021匹配度 1/10 · 该论文研究代码演化中函数文档的间接依赖与更新模式,属于软件工程中的文档一致性问题,未涉及静态分析、形式化验证、LLM/Agent、浮点程序分析或贝叶斯程序分析等用户核心方向。虽然与代码演化相关,但距离研究画像较远。引用 1 inbox
Devika Sondhi, Avyakt Gupta, Salil Purandare, Ankit Rana, Deepanshu Kaushal, Rahul Purandare
crossref: 2026-09-12dblp: 2026-09-12

AI 速览

一句话:研究代码演化中函数文档的间接依赖普遍性,并基于提交日志分析更新模式以建议文档更新。

软件系统演化时,一个点的修改可能需要在其他点同步修改以保持一致,但函数相关文档常被忽视,导致文档不一致。本文研究函数文档间接或隐式依赖于关联函数之外实体的普遍性。作者分析了 11 个 Java 开源仓库中的 Javadoc 注释,发现 62% 的受研究注释依赖于其他实体;并全面分析 1288 条提交日志中的文档更新,归纳更新模式以解释文档依赖的成因。这些模式可用于在仓库发生变更时,建议哪些文档应当被更新。

问题
研究问题:在代码演化场景中,函数文档常会间接或隐式依赖其他实体,却未随相关变更同步更新,从而造成文档不一致。本文关注这种间接依赖文档的普遍程度及其更新模式。
方法
方法:对 11 个 Java 开源仓库的 Javadoc 注释开展实证研究,统计间接依赖比例;并分析 1288 条 commit log 中的文档更新,归纳模式以推断依赖成因。
评估
评估/结果:所研究的 Javadoc 注释中有 62% 依赖其他实体,表明间接依赖文档相当普遍;从提交日志提炼的模式可用于推荐变更后应更新的文档。
原文摘要(Abstract)

A software system evolves over time due to factors such as bug-fixes, enhancements, optimizations and deprecation. As entities interact in a software repository, the alterations made at one point may require the changes to be reflected at various other points to maintain consistency. However, often less attention is given to making appropriate changes to the documentation associated with the functions. Inconsistent documentation is undesirable, since documentation serves as a useful source of information about the functionality. This paper presents a study on the prevalence of function documentations that are indirectly or implicitly dependent on entities other than the associated function. We observe a substantial presence of such documentations, with 62% of the studied Javadoc comments being dependent on other entities, as studied in 11 open-source repositories implemented in Java. We comprehensively analyze the nature of documentation updates made in 1288 commit logs and study patterns to reason about the cause of dependency in the documentation. Our findings from the observed patterns may be applied to suggest documentations that should be updated on making a change in the repository.

链接与引用

DOI 原文 · DBLP

BibTeX
@inproceedings{SondhiGPRKP21,
  title = {On Indirectly Dependent Documentation in the Context of Code Evolution: A Study},
  author = {Devika Sondhi and Avyakt Gupta and Salil Purandare and Ankit Rana and Deepanshu Kaushal and Rahul Purandare},
  booktitle = {ICSE},
  year = {2021},
  doi = {10.1109/icse43902.2021.00134}
}