Koodikatselmointi 2

[Ooppa]

Perustuen committiin 67d104abbf9c0e1838d29ca368c2aa0d200edd22 keskiviikkona 25 helmikuuta kello 16:30.

Koodikatselmointi 2

Yleistä

Toteutusdokumentaatio ja määrittelydokumentaatio on toteutettu mallikkaasti. Se antaa hyvä kuvan ohjelmasi toiminnasta.
Myös testausdokumentaatio oli siististi ja simppelisti toteutettu. Hyvää työtä.

Ohjelman pystyy kääntämään, mutta miinuksena se, että ilman parametrejä ajettaessa ohjelma kaatuu ArrayIndexOutOfBoundsException:iin. Suosittelisin nappaamaan sen try-catch blokilla ja tulostamaan sovelluksen käyttöohjeet jos se ajetaan ilman parametrjä. Lisäksi main-metodi heittää IOExceptionin, mutta kukaan ei ota sitä vastaan.

JavaDoc

Javadocin generointi aiheuttaa monta warning viestiä virheellisen dokumentaatio johdosta. Nämä olisi hyvä siistiä. Lisäksi itse dokumentaatio on paikkapaikoin epäselvää kuten esimerkiksi luokassa SuorituskykyTestit metodille mustatPieni() on annettu teksti "Musta pieni kuva.", joka ei kuvaa mitä metodi oikeastaan tekee. Toisaalta taas luokassa Transformer metodissa DCT() on kuvattu hyvin (ja englanniksi, kielenvaihto sekoittaa) mitä metodi oikeastaan tekee lauseella "Do discrete cosine transformation for 8*8px unit
". Tiedostoissa on myös jäänyt Netbeanssin lisäämä oletus license-header päälle - kannattanee poistaa.

Testit

Testejä on heikonlaisesti ja ne pitää suorittaa suoraan ajamalla Testi.java -tiedosto (projektin "Test" ei toimi koska testi-tiedosto on nimetty väärin).

Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0,311 sec

Testit menevät kuitenkin kaikki läpi.

Koodi

Paikoittain häiritsee suomen ja englannin kielen vaihtelu tiedostosta toiseen.

Koodi on kompaktia ja sujuvaa, mutta nimeäminen on hiukan hukassa. Ulkopuoliselle lukijalle muuttuja kuten "c" ja "n" eivät kerro mitään (luokassa Transformer). Lisäksi DCT voitaisiin mahdollisesti kirjoittaa suoraan discreteCosineTransformation, vaikka se on pitkä, niin se on hyvin kuvaava.

Tosin int x ja int y ja vastaavat voidaan jättää sikseen, koska ne ovat yleisesti tunnistettavia merkkejä.

Yhteenveto

Yleisesti ottaen loistavaa työtä, viimeisen viikon refaktoroinnin jälkeen sinulla on kasassa hyvä työ!