TIM - The Interactive Material. Jyväskylän yliopisto

Sovellusprojekti Timppa, 1. lähdekoodi katselmointi

##

Paikka: Agora, Tietotekniikan projektien kokoushuone Ag C226.1
Aika: torstai 16.4.2015 klo 8:30 - 10:00

Muistio

##

Laadittu: 16.4.2015
Muokattu: 23.4.2015

Läsnä

##

Projektiryhmä
Bek Eljurkaev
Minna Lehtomäki
Juhani Sihvonen
Hannu Viinikainen
Matias Berg, sihteeri

Tilaajat
Antti-Jussi Lakanen
Vesa Lappalainen

Ohjaajat
Mika Lehtinen

1. Katselmoinnin huomiot

##

Suurin osa Lehtisen huomioista löytyy hänen laatimastaan palautedokumentista osoitteesta https://tim.it.jyu.fi/view/timppa/L%C3%A4hdekoodin%20katselmointi%201%20huomiot. Keskityn tässä muistiossa lähinnä sanallisiin huomioihin ja tiivistämään Lehtisen huomiot.

HTML:ssä oli jonkun verran virheitä. Style-attribuutin käyttöä tulisi välttää ja laittaa suurin osa (jos ei kaikki) CSS erillisiin css-tiedostoihin. Label:ia oli myös käytetty väärin. Käyttöliittymän ja HTML:n kieli pitäisi yhtenäistää. Jonkinlainen kääntämismahdollisuus ainakin suomen ja englannin välillä olisi hyvä myös olla.

CSS- ja JS-tiedostoihin viittaamiseen pitäisi käyttää url-for-funktiota. Kaikki HTML-tunnisteet tulee päättää joko lopetustunnisteella tai vinoviivalla aloitustunnisteen lopussa. Angular-maisuutta tulisi lisätä ja tulisi välttää saman tiedoston useampaa lataamiskertaa. GetElementByID-komennoista tulisi päästä eroon, sillä jos dokumentti on pitkä, ne hidastavat dokumentin latausta. Niiden sijasta voisi käyttää Angular JS:ää, josta löytyy esimerkki tiedostosta dir.js.

JavaScript-tiedostoissa on pieniä teknisiä ongelmia, kuten puolipisteiden puuttuminen. Globaalien muuttujien määrää tulee vähentää. QuestionDialog-direktiivi ja -ohjain voivat olla samassa tiedostossa. QuestionController voi olla questionDialogi:ssa. Virheiden statuskoodeja kannattaa muuttaa.

Python-tiedostoista puuttuu dokumentaatiokommentteja joistain funktioista ja oikeuksia ei tarkisteta riittävästi. Muutama muukin pieni virhe on ilmoitettu Lehtisen huomioissa.

Lappalainen pyysi, että heti kysymyksen näyttämisen toimiessa pitäisi tehdä dokumentti, jossa on esimerkiksi 100 kysymystä ja katsoa, miten pitkään menee sivun latautumiseen. Lappalainen tiedusteli, olisiko mahdollista ulkoistaa kysymysmallien teko, jotta ne haettaisiin tekstitiedostosta tai tietokannasta, jotta ei tarvitsi editoida koodia, jotta ne voidaan lisätä. Lappalainen pyysi myös, että projektiryhmä testaa, miten palvelin reagoi, jos puhelin on yhteydessä palvelimeen ja puhelimesta irrotetaan akku.