arrow
Return

CSM: A Code Style Model for Computing Educators

delete2025-02-11
delete0
PRE
AI
K
Kirk, Diana
A
Andrew Luxton-Reilly
E
Ewan Tempero
DOI:10.1145/3716861delete
deleteOriginal
deleteOriginal request for help
deleteShare
deleteSave
Abstract

Abstract

En 中文
Objectives Code style is an important aspect of text-based programming because programs written with good style are considered easier to understand and change and so improve the maintainability of the delivered software product. However teaching code style is complicated by the existence of many style guides and standards that contain inconsistent, low-level advice. The objective of the study is to support educators in helping students understand the nature of these inconsistencies by highlighting the rationale behind rules and their contextual nature. Participants Seventy members of local and national computing science education (CSE) groups contributed in the exploratory phase. Fifty-two members of the ACM SIGCSE members mailing list and the Australasian Chapter contributed in the evaluation and refinement phases. These mailing lists represent a large, global population of CSE educators. Study Methods We created, evaluated and refined an abstract code style model (CSM) comprising a Definition and eight Principles for code style. For CSM creation, we took an exploratory approach based on an examination of the existing literature on code quality and style. To evaluate the level of community endorsement for the model, we analysed quantitative and qualitative data from an international survey questionnaire. We refined the CSM based on an analysis of the qualitative survey data. Findings Analysis of the data from the survey indicated a strong level of support for the CSM. Quantitative data revealed a general agreement with the Principles, with responses for five Principles achieving a minimum of 84 percent agreement and all Principles achieving a minimum of 66 percent agreement. Qualitative data contained very few comments that voiced dissatisfaction with a basic aspect of the model. We found that barriers to developing a community-wide CSM were the strongly-held beliefs about style held by some and the abstract nature of the CSM. Conclusions The creation of an abstract set of Principles for code style is generally perceived by the community to be worthwhile and important and our approach has high levels of endorsement. A validated version of the CSM has been created.
Keywords:
computing education
text-based programming
software quality
code style
online survey

Journal

A
ACM Transactions on Quantum Computing
IF:
6.8
Papers:
542
Citations:
508

Organization

U
Univ Auckland
Scholars:
853
Papers: 604
Citations: 194
Cited Papers

Cited Papers

Clinical impact of deoxynivalenol, 3-acetyl-deoxynivalenol and 15-acetyl-deoxynivalenol on the severity of an experimental Mycoplasma hyopneumoniae infection in pigs
err2018-06-18
err0
errOAAI
errAnnelies Michiels; Ioannis Arsenakis; Anneleen Matthijs; Filip Boyen; Geert Haesaert; Kris Audenaert; Mia Eeckhout; Siska Croubels; Freddy Haesebrouck; Dominiek Maes
errShare
errSave
Theoretical Study on a Multicenter Model Based on Different Metal Oxidation States for the Bis(imino)pyridine Iron Catalysts in Ethylene Polymerization
err2009-09-28
err0
PREAI
errVíctor L. Cruz; Javier Ramos; Javier Martínez-Salazar; Soledad Gutiérrez-Oliva; Alejandro Toro-Labbé
errShare
errSave
Blockchain Potential in AI
err
IF0
err2022-01-12
err0
PREAI
err
errShare
errSave
Should pre-hospital resuscitative thoracotomy be reserved only for penetrating chest trauma?
err2018-03-21
err0
PREAI
errEdward J. Nevins; Parisa L. Moori; Jonathan Smith-Williams; Nicholas T. E. Bird; John V. Taylor; Nikhil Misra
errShare
errSave
Using thematic analysis in psychology
err2006-01-01
err0
PREAI
errVirginia Braun; Victoria Clarke
errShare
errSave
errShare
errSave
An empirically based terminology and taxonomy for global software engineering
err2012-07-18
err78
errOAAI
errSmite, Darja; Wohlin, Claes; Galvina, Zane; Prikladnicki, Rafael
errShare
errSave
Detecting Code Quality Issues in Pre-written Templates of Programming Tasks in Online Courses
err2023-06-30
err0
errOAAI
errAnastasiia Birillo; Elizaveta Artser; Yaroslav Golubev; Maria Tigina; Hieke Keuning; Nikolay Vyahhi; Timofey Bryksin
errShare
errSave
researcher View more