Vertaisarviointi

[jpirhel]

Lähdekoodi kloonattu: 6.10.2023 noin klo 19:00

uusin commit latausaikana:

Thu Oct 5 14:31:37 2023 +0300

Nämä kommentit pureutuvat valitettavasti enemmän lähdekoodin tekniseen laatuun kuin ohjelman rakenteeseen. Itse jako luokkiin ja tiedostoihin näytti silmääni kyllä varsin hyvältä, ja erityisesti algoritmien toteutus näytti kompaktilta.

parannusehdotus 1:

Virheiden käsittelyä voisi parantaa. Näyttäisi siltä, että lähdekoodissa (mm. util-funktiot, GUI) ei ole useinkaan varauduttu mahdollisiin virhetilanteisiin, vaan kaiken oletetaan toimivan. Tämä ei ole ohjelman luotettavuuden kannalta paras mahdollinen tilanne.

parannusehdotus 2:

Loggausta saattaisi olla hyödyllistä lisätä. Joihinkin paikkoihin loggausta on siroteltu melko hyvin, mutta esim. util-funktioiden luokissa vaikuttaisi siltä, että loggausta ei ole lainkaan.

parannusehdotus 3:

Lähdekoodin kommentointi: Vaikka luokissa ja metodeissa on melko hyvin doctstringejä, metodien sisällä ei ole lähes lainkaan kommentteja. On hankala seurata, esim. miten käyttöliittymä rakentuu, koodia pitäisi lukea todella tarkasti, jotta tämä selkiytyy. Jos koodin sekaan ripottelee jonkin verran kommentteja, niin lähdekoodin seuraaminen helpottuisi.

parannusehdotus 4:

Jakaisin ehkä responder, station ja emergency -tyypit yläluokkaan jossa olisi yhteiset metodit, sekä aliluokkiin per tyyppi. Tämä saattaisi selkiyttää ohjelman rakennetta, ja antaisi mahdollisuuden toteuttaa tarvittaessa tyyppikohtaiset metodit kätevästi.

huomioita testauksesta

Testauksessa näyttäisi olevan testattu kaikki ohjelman olennaiset komponentit, mutta pisti silmään, että lähes kaikille luokille on vain muutama testi. Saattaisi olla hyödyllistä pohtia, onko tämä testikattavuus riittävä. Kokeillessani kaikki testit menivät virheettä läpi.

Yleisiä huomioita:

Ohjelman käyttöliittymässä saattaisi olla hieman viilattavaa, ja oli hieman vaikea hahmottaa, mitä station-tyypit, responderit jne. tekevät. Havaitsin, että oikeaklikkauksella saa luotua responderin, ja sitten kun tein creatella uuden emergencyn (ja ensin piti klikata kartalle), sain ohjelman laskemaan reitin. Vielä en huomannut, laskiko ohjelma reitin IDA*:lla vai Dijkstralla - ehkä voisi olla hyödyllistä laskea reitit yhtäaikaisesti molemmilla, ja jotenkin vertailla niitä? En tiedä onko tämä mahdollista, laskenta saattaa olla pienellä reitin pituudella niin tehokasta, että on mahdotonta tehdä esim. aikavertailua. Mutta joku algoritmi-step-counter voisi olla kenties toteutettavissa.

Muuten käyttöliittymä näytti varsin hyvältä, ja karttatausta kyllä toimi varsin hienosti.

Itse lähdekoodi näytti silmääni varsin laadukkaalta, ja erityisesti pisti silmään hyvät luokkien ja metodien nimeämiset sekä lähes kaikissa metodeissa Pythonin docstringit - tämä on erittäin positiivista. Käytössä näytti olevan myös metodien argumenttien tyypit, mikä on sekin positiivista Python-koodissa.