Paatti-projektin ensimmäinen lähdekoodikatselmointi

Aika: Torstai 12.4.2012 klo 14.45 - 16.15
Paikka: Sovellusprojektien kokoustila AgC223.1

Muistio:
- laadittu: 12.4.2012

Läsnä:

projektiryhmä:
- Toni Salminen
- Jari Salokangas
- Lauri Satokangas
- Tapio Keränen, sihteeri

ohjaajat:
- Jukka-Pekka Santanen
- Outa Valkama

Valkama esitti seuraavat huomiot katselmoimistaan lähdekoodeista:
- Tiedostoihin on syytä laittaa kaikkien kyseistä tiedostoa muokanneiden nimet.
- Tiedostojen alussa olevat useat import-lauseet voidaan korvata *-merkillä,
  mutta suurista paketeista kannattaa edelleenkin tuoda vain yksittäisiä osia.
- Lähdekooditiedostot olivat yleisilmeeltään selkeitä ja luettavia.
- Suurien if-else -rakenteiden käyttöön johtavien String-tyyppisten muuttujien
  korvaaminen enum-tyypeillä mahdollistaisi switch-lauseiden käytön.
- Metodien kommenteissa esiintyneet HTML-elementit (<p/> yms.) voidaan korvata
  tekemällä muotoilut lähdekoodien HTML-version luomisvaiheessa.
- Mobiilikäyttöliittymän aloittama istunto ei vanhene koskaan. Tämä voi johtaa
  tietokantayhteyksien turhaan roikkumiseen.
- Luokan DBServiceImplementation nimeäminen on syytä tehdä uudelleen. Sana
  Implementation ei yleensä esiinny rajapinnan toteuttavan luokan nimessä.
- Testaus olisi hyvä tehdä vähintään tietokantaluokille, jotta ainakin kommuni-
  kointi tietokannan kanssa olisi mahdollisimman virheetöntä.
- Paketissa paaattiDataBaseUtils on kirjoitusvirhe (ylimääräinen a-kirjain).
- Lähdekoodeissa on syytä pitäytyä yhdessä kielessä (englanti). Joidenkin muut-
  tujien nimet sekä TODO-kohdat olivat joko kokonaan tai osittain suomeksi.
- Poikkeuksien tarkistamisessa käytetyt tulostuslausekkeet tulisi muuttaa käyt-
  tämään esimerkiksi Javan omia Logger-luokkia.
- Lähdekoodimuutoksien lähetyksiin lisättyjen commit-viestien tulisi kuvata 
  muutoksen sisältö ainakin pääpiirteittäin.
- Lähdekoodien muutokset kannattaa myöskin tehdä erillisissä haaroissa, eikä
  kaikkia muutoksia päivittää suoraan master-haaraan.
- Useiden sisäkkäisten luokkien käyttäminen on hyväksyttävää, jos koodi pysyy
  siistinä. Sisäluokkien sijoittamista omiin tiedostoihinsa kannattaa harkita
  silloin, kun luokkien koot kasvavat muutamaa riviä isommiksi kokonaisuuksik-
  si.