Exploring the Impact of Source Code Linearity on the Programmer's Comprehension of API Code Examples

TY - GEN

T1 - Exploring the Impact of Source Code Linearity on the Programmer's Comprehension of API Code Examples

AU - Alharbi, Seham

AU - Kolovos, Dimitris

N1 - Publisher Copyright: © 2024 ACM. This is an author-produced version of the published paper. Uploaded in accordance with the University’s Research Publications and Open Access policy.

PY - 2024/6/13

Y1 - 2024/6/13

N2 - 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.

AB - 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.

KW - API code examples

KW - API comprehension

KW - controlled experiment

KW - human factors in software engineering

KW - source code linearity

UR - http://www.scopus.com/inward/record.url?scp=85197245655&partnerID=8YFLogxK

U2 - 10.1145/3643916.3644395

DO - 10.1145/3643916.3644395

M3 - Conference contribution

AN - SCOPUS:85197245655

T3 - IEEE International Conference on Program Comprehension

SP - 236

EP - 240

BT - Proceedings - 2024 32nd IEEE/ACM International Conference on Program Comprehension, ICPC 2024

PB - IEEE Computer Society

T2 - 32nd IEEE/ACM International Conference on Program Comprehension, ICPC 2024

Y2 - 15 April 2024 through 16 April 2024

ER -