DocumentCode
2155478
Title
Reading the documentation of invoked API functions in program comprehension
Author
Dekel, Uri ; Herbsleb, James D.
Author_Institution
Sch. of Comput. Sci., Carnegie Mellon Univ., Pittsburgh, PA
fYear
2009
fDate
17-19 May 2009
Firstpage
168
Lastpage
177
Abstract
Comprehending an unfamiliar code fragment requires an awareness of explicit usage directives that may be present in the documentation of some invoked functions. Since it is not practical for developers to thoroughly investigate every call, directives may be missed and errors may occur. We previously reported on a tool called eMoose, which highlights calls to methods with associated directives, and on a controlled comparative lab study in which eMoose users were more successful at fixing bugs in given code fragments. In this paper we attempt to shed light on the factors behind these differences with a detailed analysis of videos from the study. We argue that information foraging theory may explain the subjects´ reading choices and the impact of our tool. We also suggest ways to structure documentation to increase the prospects of knowledge acquisition.
Keywords
application program interfaces; knowledge acquisition; program debugging; software maintenance; application programming interfaces; information foraging theory; knowledge acquisition; program comprehension; software maintenance; Application software; Collaborative software; Computer bugs; Computer science; Documentation; Functional programming; Java; Knowledge acquisition; Software maintenance; Videos;
fLanguage
English
Publisher
ieee
Conference_Titel
Program Comprehension, 2009. ICPC '09. IEEE 17th International Conference on
Conference_Location
Vancouver, BC
ISSN
1092-8138
Print_ISBN
978-1-4244-3998-0
Electronic_ISBN
1092-8138
Type
conf
DOI
10.1109/ICPC.2009.5090040
Filename
5090040
Link To Document