ikpa
commented
4 years ago Kiitoksia palautteesta. Korjauksia on tehty ja osa on suunnitteilla.
-
Dokumentointi: Dokumentoinnin virheet on otettu huomioon, ja ne on tarkoitus korjata ennen seuraavaa deadlinea. Luokkakaavio on muutama viikkoa vanha, ja siihen oli tosiaan merkitty luokkia jotka ovat vasta suunnitteilla. Tulen korjaamaan sen vastaamaan tämänhetkistä tilannetta.
-
DAO:n puute: Itseasiassa Highscore (uusi nimi HighScoreDao) on Dao-luokka, se oli vain nimetty väärin.
-
Tyylivirheet: Suurin osa huonoista nimistä on muutettu kuvaavampiin nimiin.
-
Muut virheet: En ole täysin varma mistä tämä vika johtuu. Yritin toistaa vian kuten olet sen kuvaillut sekä itse 2 tasossa, että muissakin tasoissa, mutta en onnistunut. Vika saattaa johtua siitä, että ohjelma yrittää päästä käsiksi listassa seuraavaan tasoon. Tämän ei kuitenkaan pitäisi olla mahdollista, sillä olen pyrkinyt kirjoittamaan alusta asti koodin sellaiseksi, että tällaista käytöstä ei tapahtuisi. Mikäli muistat kyseisestä virheestä yhtään enempää yksityiskohtia, olisin erittäin kiitollinen.
gitjms
Ladattu to 23.4.2020 klo 3.27
Yleistä
Ikpan pelikehitelmä vaikuttaa olevan hyvin aluillaan. Vaatimusmäärittelyn luettelemia toimintoja löytyy, eli peli on jo kivasti pelattavissa.
Sovelluksessa on yhdeksän luokkaa plus käyttöjärjestelmän rakentava luokka.
Kolmelle luokalle on olemassa testit, joita on yhteensä 38. Testit ovat hyviä ja ne menevät läpi. Testikattavuus on tosin vasta 41% ja haarautumakattavuus 46%, joten testejä on varmaasti tulossa vielä lisää.
Checkstyle-raportin mukaan tyylivirheitä ei ole, lukuunottamatta kolmea ylipitkää metodia.
README:n ohjeessä ohjelman ajamiseksi on virhe. Siinä opastetaan käyttämään komentoa
mikä ei toimi, sillä pom:ssa on kirjattu mainClass:iksi labyrintti.ui.RealMain. Näin ollen komennon kuuluu olla
Sovelluksessa ei ole käytetty minkäänlaista DAO-mallia, joka olisi ollut kurssin tarkoitusperien mukaista.
Luokat
Luokat on jaettu pakkauksiin, joita on käyttöjärjestelmäpakkauksen ui lisäksi chars, object, levels ja highscore.
Paketti chars rakentaa pelaajan pelattavan hahmon, object luo muut oliot, kuten kerättävät itemit, vihollisina toimivat piikkipallot, seinät sekä tasojen maalit. Paketti levels huolehtii pelitasoista (joita on kaksi), ja highscore huolehtii pisteiden hallinnasta.
Luokkakaavio ei ole ihan kunnossa, sillä siinä on luokkia, joita ei ole olemassa, kuten Door, ButtonDoor, Hostile, Button, EnemyDoor ja Enemy. Otaksun, että nämä ovat suunnitteilla olevia luokkia. Kuitenkin luokkakaavion tulisi mielestäni esittää nykyistä versiota.
Tästä syystä luokkakaaviosta on hyötyä vain osaksi, luokkien Main, Level, Goal, Item ja MainChara osalta. Luokkakaavion mukaan luokka Level pääsee käsiksi eri pakkauksessa oleviin luokkiin Goal, Item ja MainChara, mutta siitä ei käy selville luokan MainChara pääsy paketin object luokkiin. Muutenkaan en oikein pysty lukemaan tätä kaaviota.
Sekvenssikaaviona esitetty peliruudun päivittäminen sen sijaan vaikuttaa toimivalta.
Esimerkkejä tyylivirheistä
Tyyliohjeiden mukaan "Käytä mahdollisimman kuvaavia nimiä kaikkialla" ja "Muuttujat, joilla on iso käyttöalue, tulee olla erittäin selkeästi nimettyjä".
Luokassa Level esimerkiksi käytetään maalin (Goal) luokkamuuttujana termiä "g", ja metodeissa "initialise" ja "update" hahmon sisäisenä muuttujana termiä "c" (kuten myös luokan Main luokkamuuttujana). Mielestäni tämä ei ole ohjeiden mukaista ja myös oikeasti hankalaa luettavaa.
Vaikka ohjeissa sanotaankin, että "Lyhyen metodin sisäisille muuttujille riittää yleensä lyhyempi nimi", ei mielestäni yksi kirjain ole riittävä nimeksi. Näissä voisi hyvin käyttää maalin nimenä "goal" ja hahmon nimenä "chara", kuten jälkimmäistä on muuallakin käytetty.
Tosin hyväksyisin kyllä esimerkiksi luokassa ScoreReader olevat lyhenteet "f" (File), "fw" (FileWriter), "s" (Scanner) yms., koska nämä eivät liity sovelluslogiikkaan. Sovelluslogiikassa on tärkeämpää olla hyvin kuvaavat termit, jotta kooditarinaa pystyy seuraamaan sujuvasti.
Myös luokan LvlConstructor luokkamuuttuja "wc" (WallConstructor) ei ole hyvä nimi. Luokan Goal metodin "inGoal" termi "sec" (Shape) ei myöskään avaudu. Mikä tämä "sec" on? Section?
Luokkien Item muuttuja "s" (Circle) ja Spike muuttuja "p" (polygon) ovat epämääräisiä, mutta luokkien lyhyyden ja muun selkeyden vuoksi nämä eivät ole isoja ongelmia.
Koodin on muuten ihan luettavaa. Tämä on kuitenkin aivan aluillaan oleva peli, joten on vaikea etsiä parannettavaa vielä. Koodi siis toimii tällaisenaan.
Käytänteet ovat kunnossa lukuunottamatta DAO-puutetta, ja laatu on kohdillaan paitsi aiemmin mainitsemaani kolmea ylipitkää metodia.
Muita ongelmia
Kun toisessa tasossa liikuttaa pelaajan hahmon aivan alas ja jatkaa yhä eteenpäin vaikka hahmoa ei enää näy, tulee hetken päästä virheilmoitus:
Sovellus ei kuitenkaan kaadu: peli-ikkuna katoaa ja tilalle tulee lopetusikkuna, jossa kysytään pelaajan nimeä pistetilastoa varten.
Laatuvaatimusten mukaan "Ohjelma ei saa printata Exceptioneita (Stack tracea) komentoriville, vaikka virhe ei kaataisi ohjelmaa" ja "Tarkista, ettei ohjelmasi käsittele taulukon ulkopuolelle meneviä arvoja, tai jo poistettuja arvoja", joten tämä pitäisi korjata.