Koodikatselmointi

[TheViking1970]

BudgetApp koodikatselmus

ZIP-tiedosto ladattu Githubista 3.5.2018 klo 15:36

Ei pysty buildaamaan! Tästä johtuen alla olevat tekstit perustuvat silmämääräiseen havaintoon.

Arkitehtuurikuvaus.md

• kuvat vaikuttavat olevan vanhasta versiosta, luokkakaaviossa on luokkia joita ei oikeasti ole olemassa ja projektissa on luokkia jotka eivät näy luokkakaavisossa.
• sekvenssikaaviossa vaikuttaa olevan hieman epäselvyyksiä. Nuolet yhdestä luokasta toiseen pitäisi näyttää metodi-kutsuja, nyt siinä välillä simuloidaan käyttäjän tekstisyöttöä. Myös se, että kutsuttavat metodit ovat samassa luokassa (TextUi) saa kaaviosta myös hieman vaikeaselkoisen (siinä missä nuolet menevä ja palaavat samaan luokkaan).

Checkstyle (silmämääräisesti)

• koodi näyttää hyvältä. Tosin suurin osa koodista on TextUi.java:ssa ja siinä jotkut metodit ovat tosi pitkiä.

Testit ja testikattavuus (silmämääräisesti)

• pom.xml tiedoston mukaan ui pakkaukset jätetään huomioimatta, mutta tällöin TextUi.java:sta pitäisi erotella se osa koodi joka ei liity UI:hin omaan luokkaan ja testata sitä. TransactionDaoTest ei näyttäisi olevan testi lainkaan, ja tämä on myös se tiedosto joka aiheuttaa virheen, että ei voi buildata.
• osa testeistä,ne missä testataan onko palautettu arvo tyyppia double tuntuvat melko turhilta.

JavaDoc (silmämääräisesti)

• JavaDoc on tehty muutamalle luokalle, mutta niissä ei ole lainkaan kerrottu mitä metodien attributit tarkoittavat eikä myöskään mitä palautetaan, metodin käyttäytyminen on yleensä kerrottu.

Releasen suorittaminen (viikko 5)

• releasen pystyi suorittamaan normaalisti. Teksti käyttöliittymä on askeettinen, mutta toimiva.

Parannusehdotuksia

• koodin muokkaminen, niin että on mahdollista luoda oma buildi
• TextUi-luokasta tiettyjen osin siirto uuteen luokkaan, jolloin luokkaan jäisi enää metodeja jotka liittyvät käyttöliittymään ja muuhun koodin voitaisin sitten luoda testejä
• JavaDocseihin selityksiä mitä attribuutit tarkoittavat ja mitä metodi palauttaa
• arkitehtuurikuvauksen päivittäminen vastaamaan paremmin nykytilannetta
• ehkä pitäisi olla mahdollista lisätä jokin tekstiselite siihen miksi joku tulo tai meno lisätään järestelään, esim vuokra, palkka tms... ?

Muita huomioita

• koodi on siistiä ja hyvin jaettu omiin luokkiin jotka hoitavat vain pienen osan kokonaistehtävästä (poislukien yllämainittu TextUi.java)
• aika vähän on aikaa laitettu projektiin, ja se varmaan on osaselitys siihen miksi kaikki ei toimi halutulla tavalla?

[neodyymi]

Yksi hyödyllinen tieto olisi ollut vielä kuvaus ongelmasta buildaamisessa.