Exploring the Impact of Source Code Linearity on the Programmers Comprehension of API Code Examples
Context: Application Programming Interface (API) code examples are an essential knowledge resource for learning APIs. However, a few user studies have explored how the structural characteristics of the source code in code examples impact their comprehensibility and reusability. Objectives: We invest...
Uloženo v:
| Vydáno v: | arXiv.org |
|---|---|
| Hlavní autoři: | , |
| Médium: | Paper |
| Jazyk: | angličtina |
| Vydáno: |
Ithaca
Cornell University Library, arXiv.org
03.04.2024
|
| Témata: | |
| ISSN: | 2331-8422 |
| On-line přístup: | Získat plný text |
| Tagy: |
Přidat tag
Žádné tagy, Buďte první, kdo vytvoří štítek k tomuto záznamu!
|
| Abstract | Context: Application Programming Interface (API) code examples are an essential knowledge resource for learning APIs. However, a few user studies have explored how the structural characteristics of the source code in code examples impact their comprehensibility and reusability. Objectives: We investigated whether the (a) linearity and (b) length of the source code in API code examples affect users performance in terms of correctness and time spent. We also collected subjective ratings. Methods: We conducted an online controlled code comprehension experiment with 61 Java developers. As a case study, we used the API code examples from the Joda-Time Java library. We had participants perform code comprehension and reuse tasks on variants of the example with different lengths and degrees of linearity. Findings: Participants demonstrated faster reaction times when exposed to linear code examples. However, no substantial differences in correctness or subjective ratings were observed. Implications: Our findings suggest that the linear presentation of a source code may enhance initial example understanding and reusability. This, in turn, may provide API developers with some insights into the effective structuring of their API code examples. However, we highlight the need for further investigation. |
|---|---|
| AbstractList | Context: Application Programming Interface (API) code examples are an essential knowledge resource for learning APIs. However, a few user studies have explored how the structural characteristics of the source code in code examples impact their comprehensibility and reusability. Objectives: We investigated whether the (a) linearity and (b) length of the source code in API code examples affect users performance in terms of correctness and time spent. We also collected subjective ratings. Methods: We conducted an online controlled code comprehension experiment with 61 Java developers. As a case study, we used the API code examples from the Joda-Time Java library. We had participants perform code comprehension and reuse tasks on variants of the example with different lengths and degrees of linearity. Findings: Participants demonstrated faster reaction times when exposed to linear code examples. However, no substantial differences in correctness or subjective ratings were observed. Implications: Our findings suggest that the linear presentation of a source code may enhance initial example understanding and reusability. This, in turn, may provide API developers with some insights into the effective structuring of their API code examples. However, we highlight the need for further investigation. |
| Author | Kolovos, Dimitris Alharbi, Seham |
| Author_xml | – sequence: 1 givenname: Seham surname: Alharbi fullname: Alharbi, Seham – sequence: 2 givenname: Dimitris surname: Kolovos fullname: Kolovos, Dimitris |
| BookMark | eNotj8FLwzAYxYMoOOf-AG8Bz63Jl6RtjmNMNxg4cPeRtF-3jjapSSfzv7c6T-_w3u893gO5dd4hIU-cpbJQir2YcGm-UpBMpgxEnt-QCQjBk0IC3JNZjCfGGGQ5KCUmpFxe-taHxh3ocES67npTDtTX9MOfQ4l04Sukm8ahCc3wTb37i22DPwTTdRjimOj6gEd0sRndkZxv11dseTFd32J8JHe1aSPO_nVKdq_L3WKVbN7f1ov5JjEKdKJFbaVlaLLaZlCxStuszHjOhOKiKnOdjz7XFoSVaDXwgisUwCT8UqUSU_J8re2D_zxjHPan8YMbF_eCCSgYgNbiB8HnWC4 |
| ContentType | Paper |
| Copyright | 2024. This work is published under http://creativecommons.org/publicdomain/zero/1.0/ (the “License”). Notwithstanding the ProQuest Terms and Conditions, you may use this content in accordance with the terms of the License. |
| Copyright_xml | – notice: 2024. This work is published under http://creativecommons.org/publicdomain/zero/1.0/ (the “License”). Notwithstanding the ProQuest Terms and Conditions, you may use this content in accordance with the terms of the License. |
| DBID | 8FE 8FG ABJCF ABUWG AFKRA AZQEC BENPR BGLVJ CCPQU DWQXO HCIFZ L6V M7S PHGZM PHGZT PIMPY PKEHL PQEST PQGLB PQQKQ PQUKI PRINS PTHSS |
| DOI | 10.48550/arxiv.2404.02377 |
| DatabaseName | ProQuest SciTech Collection ProQuest Technology Collection Materials Science & Engineering Collection ProQuest Central (Alumni) ProQuest Central UK/Ireland ProQuest Central Essentials ProQuest Central ProQuest Technology Collection ProQuest One ProQuest Central Korea SciTech Premium Collection ProQuest Engineering Collection Engineering Database ProQuest Central Premium ProQuest One Academic (New) ProQuest Publicly Available Content Database ProQuest One Academic Middle East (New) ProQuest One Academic Eastern Edition (DO NOT USE) ProQuest One Applied & Life Sciences ProQuest One Academic (retired) ProQuest One Academic UKI Edition ProQuest Central China Engineering Collection |
| DatabaseTitle | Publicly Available Content Database Engineering Database Technology Collection ProQuest One Academic Middle East (New) ProQuest Central Essentials ProQuest One Academic Eastern Edition ProQuest Central (Alumni Edition) SciTech Premium Collection ProQuest One Community College ProQuest Technology Collection ProQuest SciTech Collection ProQuest Central China ProQuest Central ProQuest One Applied & Life Sciences ProQuest Engineering Collection ProQuest One Academic UKI Edition ProQuest Central Korea Materials Science & Engineering Collection ProQuest Central (New) ProQuest One Academic ProQuest One Academic (New) Engineering Collection |
| DatabaseTitleList | Publicly Available Content Database |
| Database_xml | – sequence: 1 dbid: PIMPY name: Publicly Available Content Database url: http://search.proquest.com/publiccontent sourceTypes: Aggregation Database |
| DeliveryMethod | fulltext_linktorsrc |
| Discipline | Physics |
| EISSN | 2331-8422 |
| Genre | Working Paper/Pre-Print |
| GroupedDBID | 8FE 8FG ABJCF ABUWG AFKRA ALMA_UNASSIGNED_HOLDINGS AZQEC BENPR BGLVJ CCPQU DWQXO FRJ HCIFZ L6V M7S M~E PHGZM PHGZT PIMPY PKEHL PQEST PQGLB PQQKQ PQUKI PRINS PTHSS |
| ID | FETCH-LOGICAL-a529-93fb4b0ea6fb62d0d9b6c61703513dc797fb419b23b4eb921815e320424b0ec53 |
| IEDL.DBID | M7S |
| IngestDate | Mon Jun 30 09:24:04 EDT 2025 |
| IsDoiOpenAccess | true |
| IsOpenAccess | true |
| IsPeerReviewed | false |
| IsScholarly | false |
| Language | English |
| LinkModel | DirectLink |
| MergedId | FETCHMERGED-LOGICAL-a529-93fb4b0ea6fb62d0d9b6c61703513dc797fb419b23b4eb921815e320424b0ec53 |
| Notes | SourceType-Working Papers-1 ObjectType-Working Paper/Pre-Print-1 content type line 50 |
| OpenAccessLink | https://www.proquest.com/docview/3032802299?pq-origsite=%requestingapplication% |
| PQID | 3032802299 |
| PQPubID | 2050157 |
| ParticipantIDs | proquest_journals_3032802299 |
| PublicationCentury | 2000 |
| PublicationDate | 20240403 |
| PublicationDateYYYYMMDD | 2024-04-03 |
| PublicationDate_xml | – month: 04 year: 2024 text: 20240403 day: 03 |
| PublicationDecade | 2020 |
| PublicationPlace | Ithaca |
| PublicationPlace_xml | – name: Ithaca |
| PublicationTitle | arXiv.org |
| PublicationYear | 2024 |
| Publisher | Cornell University Library, arXiv.org |
| Publisher_xml | – name: Cornell University Library, arXiv.org |
| SSID | ssj0002672553 |
| Score | 1.8656658 |
| SecondaryResourceType | preprint |
| Snippet | Context: Application Programming Interface (API) code examples are an essential knowledge resource for learning APIs. However, a few user studies have explored... |
| SourceID | proquest |
| SourceType | Aggregation Database |
| SubjectTerms | Application programming interface Linearity Ratings Source code |
| Title | Exploring the Impact of Source Code Linearity on the Programmers Comprehension of API Code Examples |
| URI | https://www.proquest.com/docview/3032802299 |
| hasFullText | 1 |
| inHoldings | 1 |
| isFullTextHit | |
| isPrint | |
| link | http://cvtisr.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMwpV1NT8JAEJ0oaOLJ7_iBZA9eF9pu2-2ejBKIHCSNcMAT2d1uIxeKLRJ-vrNLxYOJF4_NdJJm2s6bzry-AbiPlJSZTBjNc2FomMQJVVp5VESIB17uFMLdsgk-GiXTqUjrhltV0yq_c6JL1FmhbY-8y6zwGwKOEA_LD2q3Rtnpar1CYx-aViXBd9S98a7HEsQcK2a2HWY66a6uLDfzdQdhLOwgWnH-KwU7XBkc__eKTqCZyqUpT2HPLM7g0PE5dXUOesetI1jhkaH7F5IUORm7Zj3pFZkh-B2KzzmW4aRYuNPSLVnLtrKJTRSlebf8drSi52M63Lr1N9JKClcXMBn0J71nWu9ToDIKBBUsV6HyjIxzFQeZlwkVa6vHziKfZZoLjnZfqICp0ChhsT8yLLCzUfTSEbuExqJYmCsgPpc6lsxWjwrjamQkteEiNp5SwgvNNbS-Qzar34lq9hOvm7_Nt3AUYOng-DGsBY1V-Wnu4ECvV_OqbEPzqT9KX9vuVuNROnxJ374Am6y0Qw |
| linkProvider | ProQuest |
| linkToHtml | http://cvtisr.summon.serialssolutions.com/2.0.0/link/0/eLvHCXMw1V1LTwIxEG4IaPTkOz5Qe9BjYWn31YMxBiEQkJDAgRtpu93IZRd3EfFH-R-dlocHE28cPHcn2d1p55vH1xmE7jwpRCRCRuKYa-KGfkikkg7hHuCBE9sO4XbYRNDrhaMR7xfQ1_oujKFVrm2iNdRRqkyOvMpM4zcAHM4fp2_ETI0y1dX1CI3ltujozw8I2fKH9jPo957SZmNYb5HVVAEiPMoJZ7F0paOFH0ufRk7Epa9MV3Lm1VikAh7Aeo1LyqSrJTcI6GlGTYUQpJQZEgEWvwReBOWWKTjYpHSoH4CDzpa1U9sprCqyxWReAdR0KwCOQfDL4lsYax78sx9wiEp9MdXZESro5BjtWraqyk-Q2jAHMfivuG1veuI0xgNbisD1NNIYomx4WwgycJrYx_pLKppJ1GNjBjP9atj7sAqST_32UqyxEKZhcn6Khtv4rDNUTNJEnyNcC4TyBTO-sQQ1auEJpQPua0dK7rj6ApXXGhqvTnw-_lHP5d_Lt2ivNXzpjrvtXucK7VNwkiwTiJVRcZa962u0o-azSZ7d2N2F0XjLyvwGWkALhA |
| openUrl | ctx_ver=Z39.88-2004&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&rfr_id=info%3Asid%2Fsummon.serialssolutions.com&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=article&rft.atitle=Exploring+the+Impact+of+Source+Code+Linearity+on+the+Programmers+Comprehension+of+API+Code+Examples&rft.jtitle=arXiv.org&rft.au=Alharbi%2C+Seham&rft.au=Kolovos%2C+Dimitris&rft.date=2024-04-03&rft.pub=Cornell+University+Library%2C+arXiv.org&rft.eissn=2331-8422&rft_id=info:doi/10.48550%2Farxiv.2404.02377 |