• DocumentCode
    2865776
  • Title

    What makes a good code example?: A study of programming Q&A in StackOverflow

  • Author

    Nasehi, S.M. ; Sillito, Jonathan ; Maurer, Frank ; Burns, C.

  • Author_Institution
    Dept. of Comput. Sci., Univ. of Calgary, Calgary, AB, Canada
  • fYear
    2012
  • fDate
    23-28 Sept. 2012
  • Firstpage
    25
  • Lastpage
    34
  • 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.
  • Keywords
    application program interfaces; programming; programming languages; API documentation; API example; StackOverflow; application programming interface; code example; learning activity; learning aid; programming Q and A web site; programming language; qualitative analysis; question-and-answer; Best practices; Conferences; Documentation; Java; Programming; Software maintenance; Web sites; API; code example; documentation; social learning;
  • fLanguage
    English
  • Publisher
    ieee
  • Conference_Titel
    Software Maintenance (ICSM), 2012 28th IEEE International Conference on
  • Conference_Location
    Trento
  • ISSN
    1063-6773
  • Print_ISBN
    978-1-4673-2313-0
  • Type

    conf

  • DOI
    10.1109/ICSM.2012.6405249
  • Filename
    6405249