Title
What makes a good code example?: A study of programming Q&A in StackOverflow
Abstract
Programmers learning how to use an API or a programming language often rely on code examples to support their learning activities. However, what makes for an effective ode example remains an open question. Finding the haracteristics of the effective examples is essential in improving the appropriateness of these learning aids. To help answer this question we have onducted a qualitative analysis of the questions and answers posted to a programming Q&A web site called StackOverflow. On StackOverflow answers can be voted on, indicating which answers were found helpful by users of the site. By analyzing these well-received answers we identified haracteristics of effective examples. We found that the explanations acompanying examples are as important as the examples themselves. Our findings have implications for the way the API documentation and example set should be developed and evolved as well as the design of the tools assisting the development of these materials.
Year
DOI
Venue
2012
10.1109/ICSM.2012.6405249
ICSM
Keywords
DocType
Citations 
StackOverflow answer,effective example,good code example,example set,web site,programming Q,open question,effective ode example,programming language,API documentation,code example
Conference
89
PageRank 
References 
Authors
3.11
20
4
Name
Order
Citations
PageRank
Jonathan Sillito181837.34
Frank Maurer2115989.71
Seyed Mehdi Nasehi31235.32
Chris Burns41425.97