sallasal / Pilkkuharjoittelu

Pilkkuharjoittelusovellus, ohjelmistotekniikan harjoitustyö
0 stars 0 forks source link

Koodikatselmointi #1

Open rajanssi opened 3 years ago

rajanssi commented 3 years ago

Ladattu: 07.12.2020, klo 16:40

-Yleisellä tasolla koodi on jaoteltu hyvin eri pakkauksiin ja luokkiin. Koodia on helppo lukea ja se on hyvin jäsennelty. Kommentteja ei ole hirveästi, mutta se ei itseasiassa ole ongelma, koska koodi selittää hyvin itsensä ja JavaDocia on jo aloiteltu paikoin tekemään. Pakkausrakenne on samanlainen kuin refrenssisovelluksessa, joka toimii tässä tapauksessa hyvin. Kuten arkkitehtuurikaaviosta näkee, niin tietokanta keskustelee vain sovelluslogiikan kanssa ja käyttöliittymä toimii erikseen. Tietokanta näyttäisi olevan myös ihan järkevästi rakennettu ja tietokannan kanssa kommunikointi tapahtuu kuten pitääkin.

-Käyttöliittymäkoodi on aika monimutkaista, mutta se taitaa pääasiassa johtua siitä, että käyttöliittymäkoodi on väistämättä vähän sellaista. Myös tässä tapauksessa eri näkymät on loogisesti jaoteltu eri luokkiin. Joitakin pieniä tyylivirheitä, (muutaman rivin lopussa, esim. LoginScene rivi 64 on puolipilkku rivin lopussa kahteen kertaan), mutta ei mitään huomattavaa ongelmaa. Myös käyttämättömiä importteja keikkuu aika monissa paikoin.

-Monessa uutta näkymää luovassa luokassa on vähän toisteista koodia metodin lopulla. Esimerkiksi AddView luokan getAddView() GridPanen addColumn metodilla nuo kaikki osat saisi kerralla asetettua, niin yhdellä rivillä koodia selvittäisiin 10 rivin sijaan!

-Käyttöliittymäkoodin eri metodeita voisi kenties pilkkoa vähän pienemmiksi. Checkstyle valittaa ainoastaan tuosta AddView luokan getAddView metodista, joten eivät ne mitenkään järkyttävän tiiviitä ole, mutta parhaassa tapauksesa näkymien getScene metodit kokoaisivat vain muissa metodeissa tehdyt elementit yhteen ja palauttaisivat uuden näkymän.

-FeedbackView luokan riviltä löytyi myös väärin asetettu setterimetodi 'setStatisticsText'. Tätä ei kyllä vielä käytetä missään kohtaa koodia, mutta jos sitä joskus tarvittaisiin, niin se kannataa korjata.

-Pääasialliset toiminnothan tässä on jo melkein valmiina. Tietokanta toimii ja suurin osa vaatimusmäärittelyn toiminallisuudesta on tehtynä. Tässä vaiheessa sanoisin, että mm. syötteen validoinnin ja ohjelman muun toiminnallisuuden viimeistelyn jälkeen käyttöliittymän piristämiseen voisi keskittyä. Nythän se on vähän kuin Lapin luonto, karu ja joidenkin mielestä kaunis. Koodista vielä muutamat kirjoitusvirheet pois, jotka varmaan löytyy checkStylen ja Netbeansin avulla niin homma on ihan hyvällä mallilla!

sallasal commented 3 years ago

Upea palaute, kiitos paljon! Ja hyviä pointteja. Tosiaan, siistimistyötä vielä on. Uskon kyllä silti, että niiden jälkeen on aikaa muokata käyttöliittymääkin enemmän kohti keskieurooppalaista lehtometsää.