Work

Generating Method Documentation Using Concrete Values from Executions

Year: 2017
Type: article
Abstract: 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.
Language: English
Open Access status: green
OpenAlex ID: W2775310939
FWCI: 2.593
Cites: 24
Cited by: 14
Related to: 10