首页    期刊浏览 2025年07月15日 星期二
登录注册

文章基本信息

  • 标题:Generating Method Documentation Using Concrete Values from Executions
  • 本地全文:下载
  • 作者:Mat{\'u}{\v{s}} Sul{\'i}r ; Jaroslav Porub{\"a}n
  • 期刊名称:OASIcs : OpenAccess Series in Informatics
  • 电子版ISSN:2190-6807
  • 出版年度:2017
  • 卷号:56
  • 页码:3:1-3:13
  • DOI:10.4230/OASIcs.SLATE.2017.3
  • 出版社:Schloss Dagstuhl -- Leibniz-Zentrum fuer Informatik
  • 摘要:There exist multiple automated approaches of source code documentation generation. They often describe methods in abstract terms, using the words contained in the static source code or code excerpts from repositories. In this paper, we introduce DynamiDoc - a simple yet effective automated documentation approach based on dynamic analysis. It traces the program being executed and records string representations of concrete argument values, a return value, and a target object state before and after each method execution. Then for every concerned method, it generates documentation sentences containing examples, such as "When called on [3, 1.2] with element = 3, the object changed to [1.2]". A qualitative evaluation is performed, listing advantages and shortcomings of the approach.
  • 关键词:documentation generation; source code summarization; methods; dynamic analysis; examples
国家哲学社会科学文献中心版权所有