Skip to content

Koodikatselmointi #2

Description

@sovalke

Otettu talteen tiistaina 27.8. klo 19.04

Projektin rakenne

Projektin rakenne on kohtalaisen selkeä. Eri koodit, materiaalit ja testit on sijoitettu selkeästi nimettyihin ja sijoiteltuihin kansioihin.

Sisäkkäisiä kansioita on tosin aika paljon – onko esimerkiksi välttämätöntä, että sinulla on ensin kansio 15puzzlesolver ja sen sisällä toinen samanniminen kansio? Eikö kansiot 15puzzlesolver ja Docs voisi sijoittaa suoraan projektin juureen?

Dokumentaatio

Dokumentaatio on ytimekästä ja selkeää. Tarvittaviin paikkoihin on lisätty diagrammeja/käppyröitä myös kuvina, mikä selkeyttää dokumentointia.

Koodikattavuus ja testit

Ohjelma kääntyi hyvin ja toimi odotetusti.

Yksikkötestauksessa testien koodikattavuus näyttäisi olevan hyvällä tasolla. Solverille kaipailisin vielä testejä.

Suorituskykytestiä en paketista löytänyt, en liioin dokumentaatiosta. Jonkinlainen suorityskykytesti olisi hyvä liittää projektiin mukaan.

Koodin laatu ja siisteys

Koodi on helppolukuista ja selkeästi kommentoitua. Jokaiselle metodille oli selkeä kommentti, joten oli helppo seurata, mitä missäkin luokassa ja metodissa tapahtuu.

Koodi oli myös mukavan ilmavaa (ei liian tiiviiksi paketiksi puristettua), mikä teki siitä helppolukuista. Muuttujat ja luokat oli nimetty hyvin.

Monet tiedostot, kuten PuzzleGen.java ja IDDFS.java, sisälsivät importteja, joita ei käytetä (mm. import java.util.Arrays). Ne voisi napata pois.

Kokonaisuutena

Projekti on selkeä ja helppolukuinen, ja tekee sen mitä lupaa. Kun vielä viilataan suorituskykytesti kuntoon ja siivotaan koodista mm. turhat importit pois, tästä tulee todella hyvä.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions