Koodikatselmointi

[caeh17]

Koodikatselmointi harjoitustyöstä Liikuntapaivakirja Ladattu 3.5. klo 21.33

Kommentit pakkauksittain:

UI-pakkaus

• Käyttöliittymän rakentava luokka erittäin pitkä; voisiko sitä pilkkoa useampaan luokkaan? Muuten UI oli mielestäni selkeästi rakennettu ja huolella suunniteltu, joten pituudestaan huolimatta koodia pystyi seuraamaan aika hyvin.

Dao-pakkaus:

• Tietokannan luomisesta DatabaseTest-luokassa: eikö riittäisi, että olisi yksi metodi, joka yrittää luoda tietokantataulut User ja Diary, jos niitä ei jo ole? Säästyisi monta riviä koodia… Eli SQL:n voisi muotoilla näin: “CREATE TABLE IF NOT EXISTS […]”
• Dao-pakkauksen testiluokissa suosittelen käyttämään junitin TemporaryFolder-luokkaa, jolla voit luoda tilapäisen tietokantatiedoston, jonka voi sitten testien jälkeen @After-tilassa deletoida. Voit ottaa mallia kurssin esimerkkisovelluksesta. Näin säästyt pitämästä mukana test.db-tiedostoa. Tällöin myös testit eivät mene rikki, vaikka test.db korruptoituisi tai katoaisi. (Kokeilin poistaa tiedoston ja testit hajosivat. TemporaryFolder-ratkaisu on immuuni tälle.)
• Tiedostoista puheen ollen suosittelen, että tietokantatiedostot lisättäisiin .gitignoreen.
• DbDiaryEntryDao ja DbUserDao molemmat mielestäni selkeästi ja hyvien käytäntöjen mukaisesti toteutettu. Dao-suunnittelumalli on ymmärretty hyvin ja sitä on osattu käyttää.

Domain-pakkaus:

• Luokilla selkeät vastuualueet ja ne koostuvat verraten lyhyistä, helposti ymmärrettävistä metodeista
• Testejä samaten helppo ymmärtää ja seurata

Yleistä:

• JavaDoc kiitettävän tarkasti laadittu, ja helpotti katselmoijan työtä!
• Kaikki komentorivitoiminnot pystyi (alussa) suorittamaan ohjeiden mukaisesti
• Muutenkin hyvin tehty dokumentaatio
• Koodin yleisilme erittäin siisti ja enimmäkseen hyviä käytäntöjä noudattava
• Kurssin Clean code-käytäntöjen kohdat 1-6 toteutuvat oikein hyvin
• Tuli mieleen, että ohjelmaa varmaan olisi hyvä vielä laajentaa ennen loppupalautusta, esim. uusia tilasto-ominaisuuksia voisi sille tehdä (vinkki: kurssimateriaalin esimerkki ulkoisista kirjastoista)

Kaiken kaikkiaan siis hyvää työtä. Onnea loppukurssille!

[elgecaro]

Kiitos hyvästä palautteesta! Olenkin aikonut muokata testitietokannan toteusta (kun nykyinen onkin "vähän" hölmö), ja TemporaryFolder-luokka olisi varmaan hyvä siihen. Myös mainitsemasi tilasto-ominaisuus on hyvä idea :+1: