Sovelluksen koodipohjan laatuanalyysi Clean Code -periaatteita hyödyntäen
Stenvall, Matti (2024)
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2024112830894
https://urn.fi/URN:NBN:fi:amk-2024112830894
Tiivistelmä
Tämän insinöörityön tarkoituksena oli arvioida IT-alan startup-yrityksen kehittämän verkkopohjaisen sovelluksen lähdekoodin laatua ja versionhallinnan käyttöä hyödyntämällä Clean Code -periaatteita ja GitHubin parhaita käytäntöjä. Saaduista tuloksista koottiin joukko suosituksia, joita hyödyntämällä sovelluskehitystyötä ja lähdekoodin laatua voitaisiin parantaa. Työssä keskityttiin erityisesti koodin rakenteellisen laadun analysointiin.
Työn toteutus alkoi sovelluksen lähdekoodin, versionhallinnan ja hakemistorakenteen staattisella analyysillä, joka toteutettiin tarkastelemalla sovelluksen repositoriota ja koodipohjaa manuaalisesti. Analyysin tukena käytettiin SonarQube-ohjelmistoa, joka etsi lähdekoodista puutteita myös tietoturvan näkökulmasta. Analyysissä tarkasteltiin koodin nimeämiskäytäntöjä, toiston välttämistä, yhden vastuun periaatetta, modulaarisuutta, rakennetta ja dokumentoinnin selkeyttä.
Tulokset paljastivat puutteita erityisesti yhden vastuun periaatteen, toistojen välttämisen sekä dokumentaation osalta. Tämä heikensi koodin ylläpidettävyyttä ja helppolukuisuutta. Parannusehdotuksina suositeltiin koodin refaktorointia sekä selkeämpiä versionhallintakäytäntöjä.
Tulosten pohjalta todettiin, että Clean Code -periaatteiden systemaattinen soveltaminen parantaisi merkittävästi startup-yrityksen lähdekoodin laatua. Työn tuloksia voidaan hyödyntää sovelluksen jatkokehityksessä ja myös muissa ohjelmistokehitysprojekteissa, joissa halutaan kiinnittää huomiota lähdekoodin laatuun.
Työn toteutus alkoi sovelluksen lähdekoodin, versionhallinnan ja hakemistorakenteen staattisella analyysillä, joka toteutettiin tarkastelemalla sovelluksen repositoriota ja koodipohjaa manuaalisesti. Analyysin tukena käytettiin SonarQube-ohjelmistoa, joka etsi lähdekoodista puutteita myös tietoturvan näkökulmasta. Analyysissä tarkasteltiin koodin nimeämiskäytäntöjä, toiston välttämistä, yhden vastuun periaatetta, modulaarisuutta, rakennetta ja dokumentoinnin selkeyttä.
Tulokset paljastivat puutteita erityisesti yhden vastuun periaatteen, toistojen välttämisen sekä dokumentaation osalta. Tämä heikensi koodin ylläpidettävyyttä ja helppolukuisuutta. Parannusehdotuksina suositeltiin koodin refaktorointia sekä selkeämpiä versionhallintakäytäntöjä.
Tulosten pohjalta todettiin, että Clean Code -periaatteiden systemaattinen soveltaminen parantaisi merkittävästi startup-yrityksen lähdekoodin laatua. Työn tuloksia voidaan hyödyntää sovelluksen jatkokehityksessä ja myös muissa ohjelmistokehitysprojekteissa, joissa halutaan kiinnittää huomiota lähdekoodin laatuun.