Koodikriitikko : a static code analyzer for C-programs

Abstract

Students learning C-programming and programming altogether often make simple mistakes, and write code that lacks good style and violates coding conventions. On LUT University’s Principles of C-Programming course this is addressed with a programming guide that introduces the conventions students are expected to follow on the course. However, the conventions are only enforced in the course project and exam by the course staff’s manual evaluation. This poses two significant issues: students cannot receive feedback on coding conventions throughout most of the course, and manual evaluation is work-intensive for the course staff and prone to human error. To combat these issues, Koodikriitikko was created. Koodikriitikko is a static code analysis tool that analyzes student’s code for common coding convention and style violations. It provides students with continuous and actionable feedback throughout the course to support in learning. It also assists the course staff in evaluating students’ projects and exams by detecting common mistakes. Evaluation of Koodikriitikko revealed promising results, highlighting the value of pursuing further research and development. Further research and development is required before Koodikriitikko can be taken into real-world use on the Principles of C-Programming course.

C-ohjelmointia ja ohjelmointia kaiken kaikkiaan opettelevat opiskelijat tekevät yksinkertaisia virheitä ja kirjoittavat koodia, joka on tyyliltään huonoa ja rikkoo ohjelmointikäytäntöjä. LUT-yliopiston C-ohjelmoinnin perusteiden kurssilla tähän puututaan ohjelmointioppaalla, joka esittelee ohjelmointikäytännöt, joita opiskelijan odotetaan kurssilla noudattavan. Käytäntöjen noudattamista valvotaan kuitenkin pelkästään kurssiprojektissa ja tentissä, jotka kurssihenkilökunta arvioi manuaalisesti. Tämä johtaa kahteen merkittävään ongelmaan: opiskelijat eivät saa palautetta ohjelmointikäytäntöjen noudattamisesta suurimmalla osaa kurssista, ja manuaalinen arvionti on kurssihenkilökunnalle työintensiivistä ja altis inhimillisille virheille. Koodikriitikko luotiin näiden ongelmien torjumiseksi. Koodikriitikko on staattinen koodianalyysityökalu, joka analysoi opiskelijoiden koodia yleisten ohjelmointikäytäntöjen ja tyylien rikkomusten varalta. Se tukee opiskelijoiden oppimista antamalla heille jatkuvaa ja toimintaan ohjaavaa palautetta läpi kurssin. Lisäksi, se avustaa kurssihenkilökuntaa opiskelijoiden projektien ja tenttien arvioinnissa havaitsemalla yleisiä virheitä. Koodikriitikon arviointi toi ilmi lupaavia tuloksia, jotka korostavat jatkotutkimuksen ja -kehityksen arvoa. Jatkotutkimus ja -kehitys on välttämätöntä ennen kuin Koodikriitikko voidaan ottaa todelliseen käyttöön C-ohjelmoinnin perusteiden kurssilla.