The DOI matches its Crossref record; 33 of the 33 references it cites were found in a registry or an index.
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.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cites
A Coefficient of Agreement for Nominal Scales
Cohen, J. (1960) · Educational and Psychological Measurement · doi:10.1177/001316446002000104 · Cited by 42,398
(2006) · Cited by 18,730
Constructing grounded theory. A practical guide through qualitative analysis
Brink, E., Dellve, L., Hallberg, U., Abrahamsson, K. H., Klingberg, G., & Wentz, K. (2006) · International Journal of Qualitative Studies on Health and Well-being · doi:10.3402/qhw.v1i3.4932 · Cited by 6,862
Krueger, C. W. (1992) · ACM Computing Surveys · doi:10.1145/130844.130856 · Cited by 1,431
(2010) · Cambridge University Press eBooks · doi:10.1017/cbo9780511844744 · Cited by 575
Design lessons from the fastest q&a site in the west
Mamykina, L., Manoim, B., Mittal, M., Hripcsak, G., & Hartmann, B. (2011) · Proceedings of the SIGCHI Conference on Human Factors in Computing Systems · doi:10.1145/1978942.1979366 · Cited by 553
Six Learning Barriers in End-User Programming Systems
Ko, A. J., Myers, B. A., & Aung, H. H. (2004) · 2004 IEEE Symposium on Visual Languages - Human Centric Computing · doi:10.1109/vlhcc.2004.47 · Cited by 549
(2009) · doi:10.1145/1518701.1518944 · Cited by 447
How do programmers ask and answer questions on the web? (NIER track)
Treude, C., Barzilay, O., & Storey, M.-A. (2011) · Proceedings of the 33rd International Conference on Software Engineering · doi:10.1145/1985793.1985907 · Cited by 405
What Makes APIs Hard to Learn? Answers from Developers
Robillard, M. P. (2009) · IEEE Software · doi:10.1109/ms.2009.193 · Cited by 382
Mining API patterns as partial orders from source code: from usage scenarios to specifications
Acharya, M., Xie, T., Pei, J., & Xu, J. (2007) · Proceedings of the the 6th joint meeting of the European software engineering conference and the ACM SIGSOFT symposium on The foundations of software engineering · doi:10.1145/1287624.1287630 · Cited by 261
Toward Social Learning Environments
Vassileva, J. (2008) · IEEE Transactions on Learning Technologies · doi:10.1109/tlt.2009.4 · Cited by 219
MAPO: mining API usages from open source repositories
Xie, T., & Pei, J. (2006) · Proceedings of the 2006 international workshop on Mining software repositories · doi:10.1145/1137983.1137997 · Cited by 201
Improving API documentation usability with knowledge pushing
Dekel, U., & Herbsleb, J. D. (2009) · ACM/IEEE International Conference on Software Engineering: Companion Proceedings (ICSE-Companion) · doi:10.1109/icse.2009.5070532 · Cited by 141
Measuring API documentation on the web
Parnin, C., & Treude, C. (2011) · doi:10.1145/1984701.1984706 · Cited by 139
Leveraging usage similarity for effective retrieval of examples in code repositories
Bajracharya, S. K., Ossher, J., & Lopes, C. V. (2010) · ACM Joint European Software Engineering Conference and Symposium on the Foundations of Software Engineering (ESEC/FSE) · doi:10.1145/1882291.1882316 · Cited by 124
The reuse of uses in Smalltalk programming
Rosson, M. B., & Carroll, J. M. (1996) · ACM Transactions on Computer-Human Interaction · doi:10.1145/234526.234530 · Cited by 124
Dagenais, B., & Robillard, M. P. (2010) · Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering · doi:10.1145/1882291.1882312 · Cited by 124
Using Data Fusion and Web Mining to Support Feature Location in Software
Revelle, M., Dit, B., & Poshyvanyk, D. (2010) · 2010 IEEE 18th International Conference on Program Comprehension · doi:10.1109/icpc.2010.10 · Cited by 105
Strathcona example recommendation tool
Holmes, R., Walker, R. J., & Murphy, G. C. (2005) · ACM Joint European Software Engineering Conference and Symposium on the Foundations of Software Engineering (ESEC/FSE) · doi:10.1145/1081706.1081744 · Cited by 88
Obstacles in Using Frameworks and APIs: An Exploratory Study of Programmers' Newsgroup Discussions
Hou, D., & Li, L. (2011) · IEEE International Conference on Program Comprehension (ICPC) · doi:10.1109/icpc.2011.21 · Cited by 87
Finding relevant answers in software forums
Gottipati, S., Lo, D., & Jiang, J. (2011) · IEEE/ACM International Conference on Automated Software Engineering (ASE) · doi:10.1109/ase.2011.6100069 · Cited by 83
Improving API documentation using API usage information
Stylos, J., Faulring, A. R., Yang, Z., & Myers, B. A. (2009) · IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC) · doi:10.1109/vlhcc.2009.5295283 · Cited by 82
What should developers be aware of? An empirical study on the directives of API documentation
Monperrus, M., Eichberg, M., Tekes, E., & Mezini, M. (2011) · Empirical Software Engineering · doi:10.1007/s10664-011-9186-4 · Cited by 75
What should developers be aware of? : an empirical study on the directives of API documentationPreprint
Monperrus, M., Eichberg, M., Tekes, E., & Mezini, M. (2012) · Cited by 58
The information gathering strategies of software maintainers
Seaman, C. B. (2003) · International Conference on Software Maintenance · doi:10.1109/icsm.2002.1167761 · Cited by 49
Strathcona example recommendation tool
Holmes, R., Walker, R. J., & Murphy, G. C. (2005) · ACM SIGSOFT Software Engineering Notes · doi:10.1145/1095430.1081744 · Cited by 34
Unit tests as API usage examples
Nasehi, S. M., & Maurer, F. (2010) · Proceedings/Proceedings - Conference on Software Maintenance · doi:10.1109/icsm.2010.5609553 · Cited by 31
Self-citationFacilitators and Inhibitors of End-User Development by Teachers in a School Environment
Wiedenbeck, S. (2005) · Proceedings/Proceedings -- IEEE Symposium on Visual Languages and Human-Centric Computing · doi:10.1109/vlhcc.2005.36 · Cited by 30
Automatically locating framework extension examples
Dagenais, B., & Ossher, H. L. (2008) · ACM SIGSOFT International Symposium on Foundations of Software Engineering (FSE) · doi:10.1145/1453101.1453129 · Cited by 29
Reading the documentation of invoked API functions in program comprehension
Dekel, U., & Herbsleb, J. D. (2009) · IEEE International Conference on Program Comprehension (ICPC) · doi:10.1109/icpc.2009.5090040 · Cited by 25
Portfolio: a search engine for finding functions and their usages
McMillan, C., Grechanik, M., Poshyvanyk, D., Xie, Q., & Fu, C. (2011) · ACM/IEEE International Conference on Software Engineering: Companion Proceedings (ICSE-Companion) · doi:10.1145/1985793.1985991 · Cited by 13
Investigating the effects of framework design knowledge in example-based framework learning
Hou, D. (2008) · IEEE International Conference on Software Maintenance (ICSM) · doi:10.1109/icsm.2008.4658052 · Cited by 11
Cited by
An empirical study on TensorFlow program bugs
Zhang, Y., Chen, Y., Cheung, S.-C., Xiong, Y., & Zhang, L. (2018) · Proceedings of the 27th ACM SIGSOFT International Symposium on Software Testing and Analysis · doi:10.1145/3213846.3213866 · Cited by 304
Kabir, S., Udo-Imeh, D. N., Kou, B., & Zhang, T. (2024) · Proceedings of the CHI Conference on Human Factors in Computing Systems · doi:10.1145/3613904.3642596 · Cited by 160
How do API changes trigger stack overflow discussions? a study on the Android SDK
Linares-Vásquez, M., Bavota, G., Di Penta, M., Oliveto, R., & Poshyvanyk, D. (2014) · Proceedings of the 22nd International Conference on Program Comprehension · doi:10.1145/2597008.2597155 · Cited by 146
Retrieval Augmented Code Generation and Summarization
Parvez, M. R., Ahmad, W., Chakraborty, S., Ray, B., & Chang, K.-W. (2021) · Findings of the Association for Computational Linguistics: EMNLP 2021 · doi:10.18653/v1/2021.findings-emnlp.232 · Cited by 141
The Effects of Generative AI on Computing Students’ Help-Seeking Preferences
Hou, I., Mettille, S., Man, O., Li, Z., Zastudil, C., & MacNeil, S. (2024) · Proceedings of the 26th Australasian Computing Education Conference · doi:10.1145/3636243.3636248 · Cited by 97
Metadata
- Authors
- Nasehi, S. M., Sillito, J., Maurer, F., & Burns, C.
- Venue
- 2012 28th IEEE International Conference on Software Maintenance (ICSM)
- Publisher
- IEEE
- Published
- 2012-09
- Pages
- 25-34
- ISSN
- 1063-6773 (ISSN-L)
- OpenAlex
- W2051204868
- Cited by
- 287
- References
- 33
- FWCI
- 12.89
- Type
- conference paper
- Language
- en
- Open access
- closed
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.