Vertaisarviointi

[att78]

Loppupalautuksessa sovelluksen osuus on 30 pistettä ja dokumentaation 10 pistettä. Kokosin vertaisarviointiin huomioita, joiden toivon auttavan loppupalautuksen tekemisessä.

Dokumentaatio antaa maksimissaan 10 pistettä:
Dokumentaatiossa olisi 3 selkeää parannettavaa asiaa. Lopullisessa versiossa tulisi olla käyttöohje. Siitä saa maksimissaan 2 pistettä. Kurssin ohjeissa on myös mainittu, että määrittely ja toteutusdokumenteilla tulisi olla lähdeluettelo merkitty näkyviin. Pieni pisteparannus tästäkin todennäköisesti tulisi.
Kolmantena sitten testausdokumenttiin liittyen parannusehdotus. Testausdokumentissa tulisi käsitellä testauksen kattavuus ja suorituskykytestaus. Nykyisellään raportissa on käsitelty suorituskykyä, mutta testauksen kattavuuksia ei raportissa ole. Kurssin ohjeissa on kuitenkin ilmaistu, että testaus tulee toteuttaa ja testikattavuus tulee käsitellä harjoitustyön toteutuskielestä riippumatta. Jos testausta ja kattavuutta ei käsitellä, olisi hyvä testausdokumentissa perustella, miksi näin on.

Koodin laatu antaa maksimissaan 5 pistettä:
Nykyisellään toteutuksessa on tarvetta refaktoroinnille. Eniten koodin selkeyttämisen tarpeessa on decompress, joka on aivan liian pitkä metodi ja tekee aivan liian montaa asiaa. Koodin kosmeettinen parantelu lienee aika nopea homma.
Toinen laadullinen ongelma toteutuksessa on se, että tiedostonkäsittely on sekoitettu varsinaiseen suorittavaan koodiin. Hyvä käytänne olisi pitää tiedostonkäsittely selkeästi erillään suorittavasta koodista.

Koodin kommentointi ja kommentoiva koodi antaa maksimissaan 5 pistettä:
Decompress on kyllä hyvin kommentoitu, mutta kommentit ovat metodin sisällä. Hyvä käytänne olisi kommentoida metodin ulkopuolella eikä sen sisäpuolella. Tämäkin puhuu refaktoroinnin puolesta.

Testaus antaa maksimissaan 10 pistettä:
Kurssin sivuilla on erikseen ilmaistu, ettei harjoitustyön tekeminen C-kielellä vapauta testaamisen ja testikattavuuden seuraamisen ikeestä. Olisikin suositeltavaa, että harjoitustyön kattavuudet vietäisiin esimerkiksi Codecoviin ja raportoitaisiin selkeästi.

Testien ajaminen make test komennolla ei onnistunut suoraan githubilta ladatussa versiossa sovelluksesta. Ilmeisesti ”make test”issä test-files.sh:n johtava polku on väärin. ”cd test-files”in sijaan pitäisi olla ”cd test” tms. En jaksanut penkoa tätä asiaa sen enempää vertaisarviointia varten. Testasin linuxin komentorivin kautta. Loppupalautukseen kannattaa make test:in toimivuus varmistaa.

Loppukommenttina haluan todeta, että huomioithan harjoitustyön arvosteluperusteet loppupalautusta tehdessäsi. Tiralabran nettisivujen perusteella 50/60 pistettä tulee periaatteessa muista asioista kuin toimivasta sovelluksesta. Siksipä niihin muihin asioihin kannattaa panostaa. Toivotan hyvää loppupalautuksen tekoa ja kesän jatkoa.